org.yamcs.xtce

Class EnumeratedParameterType

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.BaseDataType

org.yamcs.xtce.EnumeratedDataType

org.yamcs.xtce.EnumeratedParameterType

All Implemented Interfaces:

Serializable, DataType, ParameterType

public class EnumeratedParameterType
extends EnumeratedDataType
implements ParameterType

See Also:

Serialized Form

Field Summary

Fields inherited from class org.yamcs.xtce.EnumeratedDataType

enumeration, enumerationList, 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

Constructor and Description
EnumeratedParameterType(EnumeratedParameterType t) Copy constructor
EnumeratedParameterType(String name)

Method Summary

Modifier and Type	Method and Description
void	addAlarm(MatchCriteria contextMatch, String enumLabel, AlarmLevels level) Adds a new contextual alarm for the specified value
void	addContextAlarm(EnumerationContextAlarm nca)
String	calibrate(long raw)
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
EnumerationAlarm	createOrGetAlarm(MatchCriteria contextMatch)
String	getCalibrationDescription()
EnumerationContextAlarm	getContextAlarm(MatchCriteria contextMatch)
List<EnumerationContextAlarm>	getContextAlarmList()
EnumerationAlarm	getDefaultAlarm()
Set<Parameter>	getDependentParameters()
boolean	hasAlarm() Whether this ParameterType has any alarms associated
void	setContextAlarmList(List<EnumerationContextAlarm> contextAlarmList)
void	setDefaultAlarm(EnumerationAlarm enumerationAlarm)
String	toString()

Methods inherited from class org.yamcs.xtce.EnumeratedDataType

addEnumerationRange, addEnumerationRange, addEnumerationValue, addEnumerationValue, enumValue, enumValue, getInitialValue, getTypeAsString, getValueEnumerationList, getValueEnumerationRangeList, getValueType, hasLabel, parseString

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, wait, wait, wait

Methods inherited from interface org.yamcs.xtce.ParameterType

getEncoding, parseString, parseStringForRawValue, setEncoding

Methods inherited from interface org.yamcs.xtce.DataType

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

Constructor Detail

EnumeratedParameterType

public EnumeratedParameterType(String name)

EnumeratedParameterType

public EnumeratedParameterType(EnumeratedParameterType t)

Copy constructor

Method Detail

hasAlarm

public boolean hasAlarm()

Description copied from interface: ParameterType

Whether this ParameterType has any alarms associated

Specified by:

hasAlarm in interface ParameterType

getDependentParameters

public Set<Parameter> getDependentParameters()

Specified by:

getDependentParameters in interface ParameterType

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

getDefaultAlarm

public EnumerationAlarm getDefaultAlarm()

setDefaultAlarm

public void setDefaultAlarm(EnumerationAlarm enumerationAlarm)

addContextAlarm

public void addContextAlarm(EnumerationContextAlarm nca)

getContextAlarm

public EnumerationContextAlarm getContextAlarm(MatchCriteria contextMatch)

addAlarm

public void addAlarm(MatchCriteria contextMatch,
                     String enumLabel,
                     AlarmLevels level)

Adds a new contextual alarm for the specified value

Parameters:

contextMatch - use null for the default context

createOrGetAlarm

public EnumerationAlarm createOrGetAlarm(MatchCriteria contextMatch)

getContextAlarmList

public List<EnumerationContextAlarm> getContextAlarmList()

calibrate

public String calibrate(long raw)

getCalibrationDescription

public String getCalibrationDescription()

toString

public String toString()

Overrides:

toString in class Object

setContextAlarmList

public void setContextAlarmList(List<EnumerationContextAlarm> contextAlarmList)

copy

public ParameterType copy()

Description copied from interface: ParameterType

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

Specified by:

copy in interface ParameterType

Returns: