Package org.yamcs.studio.data.vtype

Interface VEnum

All Superinterfaces:

Alarm, Enum, Scalar, Time, VType

All Known Implementing Classes:

EnumeratedVType, IVEnum

public interface VEnum
extends Scalar, Enum, Alarm, Time, VType

Scalar enum with alarm and timestamp. Given that enumerated values are of very limited use without the labels, and that the current label is the data most likely used, the enum is of type String. The index is provided as an extra field, and the list of all possible values is always provided.

Method Summary

Modifier and Type	Method	Description
int	getIndex()	Return the index of the value in the list of labels.
String	getValue()	Returns the value.

Methods inherited from interface org.yamcs.studio.data.vtype.Alarm

getAlarmName, getAlarmSeverity

Methods inherited from interface org.yamcs.studio.data.vtype.Enum

getLabels

Methods inherited from interface org.yamcs.studio.data.vtype.Time

getTimestamp, getTimeUserTag, isTimeValid

Method Details

getValue

String getValue()

Description copied from interface: Scalar

Returns the value. Never null.

Specified by:

getValue in interface Scalar

getIndex

int getIndex()

Return the index of the value in the list of labels.

Returns:

the current index