Package io.github.oblarg.oblog.annotations

Annotation Type Log.Gyro

  • @Repeatable(Gyros.class)
@Retention(RUNTIME)
@Target({FIELD,METHOD})
public static @interface Log.Gyro
    Displays a gyro with a dial from 0 to 360 degrees.
    Supported types:
    • ADXRS450_Gyro
    • AnalogGyro
    • Any custom subclass of GyroBase (such as a MXP gyro)

    Custom properties:
    NameTypeDefault ValueNotes
    Major tick spacingNumber45Degrees
    Starting angleNumber180 How far to rotate the entire dial, in degrees
    Show tick mark ringBooleantrue

    • Element Detail

      • name

        java.lang.String name
        Returns:
        The name of the value on Shuffleboard; defaults to field or method name.
        Default:
        "NO_NAME"

      • tabName

        java.lang.String tabName
        Returns:
        The name of the tab in which to place this widget, if the default inferred tab/layout is not desired. Users should be careful to avoid namespace collisions if the default tab is not used. Note that Log and config annotations can be repeated to place widgets on multiple tabs.
        Default:
        "DEFAULT"

      • methodName

        java.lang.String methodName
        Returns:
        Optional name of a method to call on the field (or return value of the method) to obtain the actual value that will be logged. Useful if one does not desire to make an entire object Loggable, but still wants to log a value from it.
        Default:
        "DEFAULT"

      • majorTickSpacing

        double majorTickSpacing
        Returns:
        Spacing of the major ticks on the compass.
        Default:
        45.0

      • startingAngle

        double startingAngle
        Returns:
        Offset of the dial, in degrees.
        Default:
        180.0

      • showTicks

        boolean showTicks
        Returns:
        Whether to show the tick marks.
        Default:
        true

      • rowIndex

        int rowIndex
        Returns:
        The row in which this widget should be placed. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • columnIndex

        int columnIndex
        Returns:
        The column in which this widget should be placed. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • width

        int width
        Returns:
        The width of this widget. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • height

        int height
        Returns:
        The height of this widget. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1