Package org.yamcs.xtce
Interface DataType
-
- All Known Subinterfaces:
ArgumentType,NumericParameterType,ParameterType
- All Known Implementing Classes:
AbsoluteTimeArgumentType,AbsoluteTimeDataType,AbsoluteTimeParameterType,AggregateArgumentType,AggregateDataType,AggregateParameterType,ArrayArgumentType,ArrayDataType,ArrayParameterType,BaseDataType,BaseTimeDataType,BinaryArgumentType,BinaryDataType,BinaryParameterType,BooleanArgumentType,BooleanDataType,BooleanParameterType,EnumeratedArgumentType,EnumeratedDataType,EnumeratedParameterType,FloatArgumentType,FloatDataType,FloatParameterType,IntegerArgumentType,IntegerDataType,IntegerParameterType,NumericDataType,StringArgumentType,StringDataType,StringParameterType
public interface DataTypeInterface for all XTCE data types.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceDataType.Builder<T extends DataType.Builder<T>>
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ObjectgetInitialValue()Get the initial value if anyStringgetLongDescription()StringgetName()StringgetShortDescription()StringgetTypeAsString()String which represents the type.Yamcs.Value.TypegetValueType()Return the expected Value type of an engineering value conforming to this XTCE data typeObjectparseString(String v)Parse a value represented as stringStringtoString(Object v)Converts a value to a string.
-
-
-
Method Detail
-
getTypeAsString
String getTypeAsString()
String which represents the type. This string will be presented to the users of the system.- Returns:
-
getName
String getName()
- Returns:
- the name of the type
-
parseString
Object parseString(String v)
Parse a value represented as string- Parameters:
v-- Returns:
-
toString
String toString(Object v)
Converts a value to a string. This should be the reverse ofparseString(String).- Parameters:
v-- Returns:
-
getInitialValue
Object getInitialValue()
Get the initial value if any- Returns:
-
getValueType
Yamcs.Value.Type getValueType()
Return the expected Value type of an engineering value conforming to this XTCE data type- Returns:
-
getShortDescription
String getShortDescription()
-
getLongDescription
String getLongDescription()
-
-