org.yamcs.xtce

Interface DataType

All Known Subinterfaces:

ArgumentType, NumericParameterType, ParameterType

All Known Implementing Classes:

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 DataType

Interface for all XTCE data types.

Author:

nm

Method Summary

Modifier and Type	Method and Description
Object	getInitialValue() Get the initial value if any
String	getLongDescription()
String	getName()
String	getShortDescription()
String	getTypeAsString() String which represents the type.
Yamcs.Value.Type	getValueType() Return the expected Value type of an engineering value conforming to this XTCE data type
Object	parseString(String v) Parse a value represented as string
void	setInitialValue(String initialValue) Sets the initial value converting from string to the specific type value.
void	setLongDescription(String longDescription)
void	setShortDescription(String shortDescription)

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

setInitialValue

void setInitialValue(String initialValue)

Sets the initial value converting from string to the specific type value.

Parameters:

initialValue -

Throws:

IllegalArgumentException - if the string cannot be converted

parseString

Object parseString(String v)

Parse a value represented as 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:

setShortDescription

void setShortDescription(String shortDescription)

getShortDescription

String getShortDescription()

setLongDescription

void setLongDescription(String longDescription)

getLongDescription

String getLongDescription()