Package io.github.oblarg.oblog.annotations

Annotation Type Log.Dial

  • @Repeatable(Dials.class)
@Retention(RUNTIME)
@Target({FIELD,METHOD})
public static @interface Log.Dial
    Displays a number with a view-only dial. Displayed values are rounded to the nearest integer.
    Supported types:
    • Number

    Custom properties:
    NameTypeDefault ValueNotes
    MinNumber0The minimum value of the dial
    MaxNumber100The maximum value of the dial
    Show valueBooleantrue Whether or not to show the value as text

    • 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"

      • min

        double min
        Returns:
        The minimum value of the dial.
        Default:
        0.0

      • max

        double max
        Returns:
        The maximum value of the dial.
        Default:
        100.0

      • showValue

        boolean showValue
        Returns:
        Whether or not to display the numeric value.
        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