org.yamcs.xtce

Class FloatParameterType

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.BaseDataType

org.yamcs.xtce.NumericDataType

org.yamcs.xtce.FloatDataType

org.yamcs.xtce.FloatParameterType

All Implemented Interfaces:

Serializable, ParameterType

public class FloatParameterType
extends FloatDataType
implements ParameterType

See Also:

Serialized Form

Field Summary

Fields inherited from class org.yamcs.xtce.BaseDataType

encoding

Fields inherited from class org.yamcs.xtce.NameDescription

name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors

Constructor and Description
FloatParameterType(FloatParameterType t) Creates a shallow copy.
FloatParameterType(String name)

Method Summary

Modifier and Type	Method and Description
void	addAlarmRange(MatchCriteria contextMatch, DoubleRange floatRange, AlarmLevels level) Adds a new, or unions with an existing range for the specified context and level
void	addContextAlarm(NumericContextAlarm nca)
void	addContextAlarms(Collection<NumericContextAlarm> ncas)
void	addCriticalAlarmRange(MatchCriteria contextMatch, DoubleRange criticalRange) Adds a new, or unions with an existing critical range for the specified context
void	addDistressAlarmRange(MatchCriteria contextMatch, DoubleRange distressRange) Adds a new, or unions with an existing distress range for the specified context
void	addSevereAlarmRange(MatchCriteria contextMatch, DoubleRange severeRange) Adds a new, or unions with an existing severe range for the specified context
void	addWarningAlarmRange(MatchCriteria contextMatch, DoubleRange warningRange) Adds a new, or unions with an existing warning range for the specified context
void	addWatchAlarmRange(MatchCriteria contextMatch, DoubleRange watchRange) Adds a new, or unions with an existing watch range for the specified context
NumericAlarm	createOrGetAlarm(MatchCriteria contextMatch)
List<NumericContextAlarm>	getContextAlarmList()
NumericAlarm	getDefaultAlarm()
Set<Parameter>	getDependentParameters()
NumericContextAlarm	getNumericContextAlarm(MatchCriteria context)
String	getTypeAsString() String which represents the type.
boolean	hasAlarm() Whether this ParameterType has any alarms associated
void	setContextAlarmList(List<NumericContextAlarm> contextAlarmList)
void	setDefaultAlarm(NumericAlarm defaultAlarm)
void	setDefaultCriticalAlarmRange(DoubleRange criticalRange)
void	setDefaultDistressAlarmRange(DoubleRange distressRange)
void	setDefaultSevereAlarmRange(DoubleRange severeRange)
void	setDefaultWarningAlarmRange(DoubleRange warningRange)
void	setDefaultWatchAlarmRange(DoubleRange watchRange)
String	toString()

Methods inherited from class org.yamcs.xtce.FloatDataType

getInitialValue, getSizeInBits, getValidRange, parseString, setInitialValue, setSizeInBits, setValidRange

Methods inherited from class org.yamcs.xtce.BaseDataType

addAllUnits, addUnit, getEncoding, getUnitSet, parseStringForRawValue, setEncoding

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, getUnitSet, parseString, parseStringForRawValue

Constructor Detail

FloatParameterType

public FloatParameterType(String name)

FloatParameterType

public FloatParameterType(FloatParameterType t)

Creates a shallow copy.

Method Detail

setDefaultWatchAlarmRange

public void setDefaultWatchAlarmRange(DoubleRange watchRange)

setDefaultWarningAlarmRange

public void setDefaultWarningAlarmRange(DoubleRange warningRange)

setDefaultDistressAlarmRange

public void setDefaultDistressAlarmRange(DoubleRange distressRange)

setDefaultCriticalAlarmRange

public void setDefaultCriticalAlarmRange(DoubleRange criticalRange)

setDefaultSevereAlarmRange

public void setDefaultSevereAlarmRange(DoubleRange severeRange)

getDefaultAlarm

public NumericAlarm getDefaultAlarm()

addAlarmRange

public void addAlarmRange(MatchCriteria contextMatch,
                          DoubleRange floatRange,
                          AlarmLevels level)

Adds a new, or unions with an existing range for the specified context and level

Parameters:

contextMatch - use null for the default context

addWatchAlarmRange

public void addWatchAlarmRange(MatchCriteria contextMatch,
                               DoubleRange watchRange)

Adds a new, or unions with an existing watch range for the specified context

Parameters:

contextMatch - use null for the default context

addWarningAlarmRange

public void addWarningAlarmRange(MatchCriteria contextMatch,
                                 DoubleRange warningRange)

Adds a new, or unions with an existing warning range for the specified context

Parameters:

contextMatch - use null for the default context

addDistressAlarmRange

public void addDistressAlarmRange(MatchCriteria contextMatch,
                                  DoubleRange distressRange)

Adds a new, or unions with an existing distress range for the specified context

Parameters:

contextMatch - use null for the default context

addCriticalAlarmRange

public void addCriticalAlarmRange(MatchCriteria contextMatch,
                                  DoubleRange criticalRange)

Adds a new, or unions with an existing critical range for the specified context

Parameters:

contextMatch - use null for the default context

addSevereAlarmRange

public void addSevereAlarmRange(MatchCriteria contextMatch,
                                DoubleRange severeRange)

Adds a new, or unions with an existing severe range for the specified context

Parameters:

contextMatch - use null for the default context

addContextAlarm

public void addContextAlarm(NumericContextAlarm nca)

addContextAlarms

public void addContextAlarms(Collection<NumericContextAlarm> ncas)

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

getNumericContextAlarm

public NumericContextAlarm getNumericContextAlarm(MatchCriteria context)

setContextAlarmList

public void setContextAlarmList(List<NumericContextAlarm> contextAlarmList)

getContextAlarmList

public List<NumericContextAlarm> getContextAlarmList()

setDefaultAlarm

public void setDefaultAlarm(NumericAlarm defaultAlarm)

createOrGetAlarm

public NumericAlarm createOrGetAlarm(MatchCriteria contextMatch)

getTypeAsString

public String getTypeAsString()

Description copied from interface: ParameterType

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

Specified by:

getTypeAsString in interface ParameterType

Returns:

toString

public String toString()

Overrides:

toString in class Object