org.yamcs.xtce

Interface ParameterType

All Superinterfaces:

DataType

All Known Subinterfaces:

NumericParameterType

All Known Implementing Classes:

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

public interface ParameterType
extends DataType

Interface implemented by all the parameters types.

Method Summary

Modifier and Type	Method and Description
ParameterType	copy() Create a shallow copy of the parameter type - the object itself (and the primitive fields) are new but the other fields reference to the same object like the original
default Set<Parameter>	getDependentParameters()
DataEncoding	getEncoding() Get the data encoding for the parameter type.
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
void	setEncoding(DataEncoding dataEncoding) Set the data encoding for the parameter type For arrays and aggregates types that do not have encoding; this operation will throw an UnsupportedOperationException

Methods inherited from interface org.yamcs.xtce.DataType

getInitialValue, getLongDescription, getName, getShortDescription, getTypeAsString, getValueType, setInitialValue, setLongDescription, setShortDescription

Method Detail

getDependentParameters

default Set<Parameter> getDependentParameters()

Returns:

the set of parameters on which this one depends in order to be extracted or alarm checked can be an empty set if this parameter does not depend on any other

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

Specified by:

parseString in interface DataType

Parameters:

stringValue -

Returns:

parseStringForRawValue

Object parseStringForRawValue(String stringValue)

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

Parameters:

stringValue -

Returns:

setEncoding

void setEncoding(DataEncoding dataEncoding)

Set the data encoding for the parameter type
For arrays and aggregates types that do not have encoding; this operation will throw an UnsupportedOperationException

Parameters:

dataEncoding -

getEncoding

DataEncoding getEncoding()

Get the data encoding for the parameter type.
For arrays and aggregates types that do not have encoding; this operation will throw an UnsupportedOperationException

Returns:

copy

ParameterType copy()

Create a shallow copy of the parameter type - the object itself (and the primitive fields) are new but the other fields reference to the same object like the original

Returns: