org.yamcs.xtce

Class EnumeratedDataType

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.BaseDataType

org.yamcs.xtce.EnumeratedDataType

All Implemented Interfaces:

Serializable, DataType

Direct Known Subclasses:

EnumeratedArgumentType, EnumeratedParameterType

public class EnumeratedDataType
extends BaseDataType

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<Long,ValueEnumeration>	enumeration
protected List<ValueEnumeration>	enumerationList
protected List<ValueEnumerationRange>	ranges

Fields inherited from class org.yamcs.xtce.BaseDataType

encoding, initialValue

Fields inherited from class org.yamcs.xtce.NameDescription

name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnumeratedDataType(EnumeratedDataType t) performs a shallow copy of this object into t

Method Summary

Modifier and Type	Method and Description
void	addEnumerationRange(double min, double max, boolean isMinInclusive, boolean isMaxInclusive, String label) Add range to enumeration list
void	addEnumerationRange(ValueEnumerationRange range)
void	addEnumerationValue(long value, String label) Add value to enumeration list
void	addEnumerationValue(ValueEnumeration ve)
ValueEnumeration	enumValue(Long key)
ValueEnumeration	enumValue(String label)
String	getInitialValue() Get the initial value if any
String	getTypeAsString() String which represents the type.
List<ValueEnumeration>	getValueEnumerationList()
List<ValueEnumerationRange>	getValueEnumerationRangeList()
Yamcs.Value.Type	getValueType() Return the expected Value type of an engineering value conforming to this XTCE data type
boolean	hasLabel(String label)
Object	parseString(String stringValue) returns stringValue

Methods inherited from class org.yamcs.xtce.BaseDataType

addAllUnits, addUnit, getEncoding, getUnitSet, parseStringForRawValue, setEncoding, setInitialValue

Methods inherited from class org.yamcs.xtce.NameDescription

addAlias, addAliases, addAncillaryData, getAlias, getAliasSet, getAncillaryData, getAncillaryDataSet, getLongDescription, getName, getName, getOpsName, getQualifiedName, getShortDescription, getSubsystemName, getSubsystemName, setAliasSet, setLongDescription, setName, setQualifiedName, setShortDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.yamcs.xtce.DataType

getLongDescription, getName, getShortDescription, setLongDescription, setShortDescription

Field Detail

enumeration

protected HashMap<Long,ValueEnumeration> enumeration

enumerationList

protected List<ValueEnumeration> enumerationList

ranges

protected List<ValueEnumerationRange> ranges

Constructor Detail

EnumeratedDataType

protected EnumeratedDataType(EnumeratedDataType t)

performs a shallow copy of this object into t

Parameters:

t -

Method Detail

getInitialValue

public String getInitialValue()

Description copied from interface: DataType

Get the initial value if any

Returns:

enumValue

public ValueEnumeration enumValue(Long key)

enumValue

public ValueEnumeration enumValue(String label)

hasLabel

public boolean hasLabel(String label)

addEnumerationValue

public void addEnumerationValue(long value,
                                String label)

Add value to enumeration list

Parameters:

value - Integer value

label - Label associated with value

addEnumerationValue

public void addEnumerationValue(ValueEnumeration ve)

addEnumerationRange

public void addEnumerationRange(double min,
                                double max,
                                boolean isMinInclusive,
                                boolean isMaxInclusive,
                                String label)

Add range to enumeration list

addEnumerationRange

public void addEnumerationRange(ValueEnumerationRange range)

getValueEnumerationList

public List<ValueEnumeration> getValueEnumerationList()

getValueEnumerationRangeList

public List<ValueEnumerationRange> getValueEnumerationRangeList()

parseString

public Object parseString(String stringValue)

returns stringValue

Specified by:

parseString in interface DataType

Specified by:

parseString in class BaseDataType

Returns:

getValueType

public Yamcs.Value.Type getValueType()

Description copied from interface: DataType

Return the expected Value type of an engineering value conforming to this XTCE data type

Returns:

getTypeAsString

public String getTypeAsString()

Description copied from interface: DataType

String which represents the type. This string will be presented to the users of the system.

Returns: