org.yamcs.xtce

Interface ParameterType

All Known Implementing Classes:

AbsoluteTimeParameterType, BinaryParameterType, BooleanParameterType, EnumeratedParameterType, FloatParameterType, IntegerParameterType, StringParameterType

public interface ParameterType

Interface implemented by all the parameters types.

Author:

nm

Method Summary

Modifier and Type	Method and Description
Set<Parameter>	getDependentParameters()
DataEncoding	getEncoding()
String	getTypeAsString() String which represents the type.
List<UnitType>	getUnitSet()
boolean	hasAlarm() Whether this ParameterType has any alarms associated
Object	parseString(String stringValue) parses the string into a java object according to the parameter type
Object	parseStringForRawValue(String stringValue) parses the string into a java object according to the parameter encoding

Method Detail

getDependentParameters

Set<Parameter> getDependentParameters()

Returns:

the set of parameters on which this one depends in order to be extracted or alarm checked

getTypeAsString

String getTypeAsString()

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

Returns:

hasAlarm

boolean hasAlarm()

Whether this ParameterType has any alarms associated

parseString

Object parseString(String stringValue)

parses the string into a java object according to the parameter type

Parameters:

stringValue -

Returns:

parseStringForRawValue

Object parseStringForRawValue(String stringValue)

parses the string into a java object according to the parameter encoding

Parameters:

stringValue -

Returns:

getUnitSet

List<UnitType> getUnitSet()

Returns:

the list of units

getEncoding

DataEncoding getEncoding()

Returns:

the data encoding for the parameter