net.jinx.action.input.robot
Interface Readout

All Known Implementing Classes:

LoopbackReadout

public interface Readout

Readout functions to provide feedback from a Robot to a Behavior. This is not the only way to provide data, but it is the preferred way.

API Stability: Alpha.

Field Summary

static int	PRIORITY_ALERT Priority for data that needs immediate attention.
static int	PRIORITY_CRITICAL Priority for data that is very important.
static int	PRIORITY_DIAGNOSTIC Priority for data that would be useful for tuning and/or debugging.
static int	PRIORITY_EMERGENCY Priority for data that is life-or-death importance.
static int	PRIORITY_INFO Priority for data that is informative in nature.
static int	PRIORITY_NONE Setting a panel to this priority indicates that nothing should be displayed and the panel is disabled.
static int	PRIORITY_WARNING Priority for data that is of a warning nature.
static int	TYPE_ANALOG Analog readouts have direction, so they would normally be displayed in a way that encompasses this.
static int	TYPE_BAR Bar readouts are usually labeled bar graphs.
static int	TYPE_BOOLEAN Boolean readouts are usually labeled indicator lights that are either lit or dark.
static int	TYPE_DANGER_BOOLEAN Similiar to a boolean readout, only the color changes as an additional indication of danger level.
static int	TYPE_DANGER_TEXT Similiar to a text readout, only the color of text changes as an additional indication of danger level.
static int	TYPE_TEXT Text readouts are displayed as a console with scrolling text.

Method Summary

java.lang.String	getName() Provides the name of this Readout; this is used for displaying a label for it.
java.lang.String	getText()
int	getType() Provides the type constant for this Readout.
float	getValue()
boolean	isFlashing()
boolean	isToggled()
int	priority() Provides the importance level of this Readout.

Field Detail

PRIORITY_NONE

static final int PRIORITY_NONE

Setting a panel to this priority indicates that nothing should be displayed and the panel is disabled.

See Also:

Constant Field Values

PRIORITY_EMERGENCY

static final int PRIORITY_EMERGENCY

Priority for data that is life-or-death importance.

See Also:

Constant Field Values

PRIORITY_ALERT

static final int PRIORITY_ALERT

Priority for data that needs immediate attention.

See Also:

Constant Field Values

PRIORITY_CRITICAL

static final int PRIORITY_CRITICAL

Priority for data that is very important.

See Also:

Constant Field Values

PRIORITY_WARNING

static final int PRIORITY_WARNING

Priority for data that is of a warning nature.

See Also:

Constant Field Values

PRIORITY_INFO

static final int PRIORITY_INFO

Priority for data that is informative in nature.

See Also:

Constant Field Values

PRIORITY_DIAGNOSTIC

static final int PRIORITY_DIAGNOSTIC

Priority for data that would be useful for tuning and/or debugging.

See Also:

Constant Field Values

TYPE_BOOLEAN

static final int TYPE_BOOLEAN

Boolean readouts are usually labeled indicator lights that are either lit or dark. The toggled flag indicates whether or not the indicator should be lit (true = lit).

See Also:

Constant Field Values

TYPE_BAR

static final int TYPE_BAR

Bar readouts are usually labeled bar graphs. The value determines the length of the bar. The value is expected to be from zero to one.

See Also:

Constant Field Values

TYPE_ANALOG

static final int TYPE_ANALOG

Analog readouts have direction, so they would normally be displayed in a way that encompasses this. The value is expected to be from negetive one to one.

See Also:

Constant Field Values

TYPE_TEXT

static final int TYPE_TEXT

Text readouts are displayed as a console with scrolling text. The toggled flag indicates whether or not the current text is new (true = new). The act of getting the text should untoggle the text.

See Also:

Constant Field Values

TYPE_DANGER_BOOLEAN

static final int TYPE_DANGER_BOOLEAN

Similiar to a boolean readout, only the color changes as an additional indication of danger level. The value determines danger level, with zero being no danger and one being maximum danger.

See Also:

Constant Field Values

TYPE_DANGER_TEXT

static final int TYPE_DANGER_TEXT

Similiar to a text readout, only the color of text changes as an additional indication of danger level. The value determines danger level, with zero being no danger and one being maximum danger.

See Also:

Constant Field Values

Method Detail

priority

int priority()

Provides the importance level of this Readout. This is used to determine if it is displayed or not, based on the priority level that has been set for the Readout's panel.

Returns:

the priority constant for this Readout. This can be any of the PRIORITY_* values, except PRIORITY_NONE.

getType

int getType()

Provides the type constant for this Readout. This determines what the Readout should look like.

Returns:

any of the TYPE_* values.

getName

java.lang.String getName()

Provides the name of this Readout; this is used for displaying a label for it.

Returns:

the name.

getValue

float getValue()

isToggled

boolean isToggled()

getText

java.lang.String getText()

isFlashing

boolean isFlashing()