Module org.yamcs.xtce

Package 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnumeratedParameterType.Builder

Field Summary

Fields inherited from class org.yamcs.xtce.EnumeratedDataType

enumeration, enumerationList, ranges

Fields inherited from class org.yamcs.xtce.BaseDataType

encoding

Fields inherited from class org.yamcs.xtce.NameDescription

ancillaryData, name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors

Constructor	Description
EnumeratedParameterType(EnumeratedParameterType t)	Copy constructor
EnumeratedParameterType(EnumeratedParameterType.Builder builder)

Method Summary

Modifier and Type	Method	Description
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)	Override the default alarm from MDB
EnumeratedParameterType.Builder	toBuilder()	Create a builder that can be used to make shallow copy of the parameter type
String	toString()

Methods inherited from class org.yamcs.xtce.EnumeratedDataType

calibrate, convertType, enumValue, enumValue, getInitialValue, getTypeAsString, getValueEnumerationList, getValueEnumerationRangeList, getValueType, hasLabel, setInitialValue

Methods inherited from class org.yamcs.xtce.BaseDataType

getEncoding, getUnitSet, parseStringForRawValue, setInitialValue, setUnitSet, toString

Methods inherited from class org.yamcs.xtce.NameDescription

addAlias, addAliases, addAncillaryData, getAlias, getAliasSet, getAncillaryData, getLongDescription, getName, getName, getOpsName, getQualifiedName, getShortDescription, getSubsystemName, getSubsystemName, qualifiedName, setAliasSet, setAncillaryData, 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.DataType

convertType, getInitialValue, getLongDescription, getName, getQualifiedName, getShortDescription, getTypeAsString, getValueType, parseStringForRawValue, toString

Methods inherited from interface org.yamcs.xtce.ParameterType

getEncoding

Constructor Details

EnumeratedParameterType

public EnumeratedParameterType(EnumeratedParameterType.Builder builder)

EnumeratedParameterType

public EnumeratedParameterType(EnumeratedParameterType t)

Copy constructor

Method Details

hasAlarm

public boolean hasAlarm()

Description copied from interface: ParameterType

Whether this ParameterType has any alarms associated

Specified by:

hasAlarm in interface ParameterType

setDefaultAlarm

public void setDefaultAlarm(EnumerationAlarm enumerationAlarm)

Override the default alarm from MDB

Parameters:

enumerationAlarm -

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()

getContextAlarm

public EnumerationContextAlarm getContextAlarm(MatchCriteria contextMatch)

getContextAlarmList

public List<EnumerationContextAlarm> getContextAlarmList()

getCalibrationDescription

public String getCalibrationDescription()

setContextAlarmList

public void setContextAlarmList(List<EnumerationContextAlarm> contextAlarmList)

toBuilder

public EnumeratedParameterType.Builder toBuilder()

Description copied from interface: ParameterType

Create a builder that can be used to make shallow copy of the parameter type

all the fields reference to the same object like the original

Specified by:

toBuilder in interface ParameterType

Returns:

toString

public String toString()

Overrides:

toString in class Object