If the methodName parameter is set, rather than the field itself being logged, the result of calling the named method on the field will be logged, instead. This can be done using the methodName parameter. Sometimes it is desirable to extract a value of a supported data type from a field of a complex data type. If the tabName parameter is set, the logged value will be displayed under a Shuffleboard tab of the specified name. The tabName parameter can be used to explicitly override Oblog’s inferred tab structure.
If the name parameter is not provided, Oblog will use the name of the annotated field or getter. The name of the value on shuffleboard (and of its corresponding NetworkTables key) can be set with the name parameter. This section describes those parameters that are common to all of the logging annotations for a detailed description of the widget-specific parameters, see the API docs. The various logging annotations take allow configuration of the logged value through a number of parameters. To log these types of data, only field annotations should be used, rather than getter annotations, as Oblog will assume that they are persistent objects.
Many Shuffleboard widget types correspond to objects that implement the WPILib Sendable interface. If an alternative widget is preferred - or if you wish to configure the logging further with widget-specific parameters - one of the widget-specific sub-annotations can be used. It will use a default widget type inferred from the type of the field or the return type of the getter, and will work with any of Oblog’s supported data types. The annotation is the most-general annotation available in Oblog. Like all Oblog annotations, this works regardless of access modifiers (e.g.
0 kommentar(er)
