Package org.yamcs.xtce

Class FloatParameterType.Builder

java.lang.Object

org.yamcs.xtce.NameDescription.Builder<T>

org.yamcs.xtce.BaseDataType.Builder<T>

org.yamcs.xtce.FloatDataType.Builder<FloatParameterType.Builder>

org.yamcs.xtce.FloatParameterType.Builder

All Implemented Interfaces:

DataType.Builder<FloatParameterType.Builder>, NumericParameterType.Builder<FloatParameterType.Builder>, ParameterType.Builder<FloatParameterType.Builder>

Enclosing class:

FloatParameterType

public static class FloatParameterType.Builder
extends FloatDataType.Builder<FloatParameterType.Builder>
implements NumericParameterType.Builder<FloatParameterType.Builder>

Field Summary

Fields inherited from class org.yamcs.xtce.BaseDataType.Builder

baseType, initialValue

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(FloatParameterType floatParameterType)

Method Summary

Modifier and Type	Method	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
FloatParameterType	build()
NumericAlarm	createOrGetAlarm(MatchCriteria contextMatch)
NumericAlarm	getDefaultAlarm()
NumericContextAlarm	getNumericContextAlarm(MatchCriteria context)
void	setContextAlarmList(List<NumericContextAlarm> contextAlarmList)	Sets the contextual alarm list overriding any other contextual alarm if already set.
void	setDefaultAlarm(NumericAlarm defaultAlarm)
void	setDefaultCriticalAlarmRange(DoubleRange criticalRange)
void	setDefaultDistressAlarmRange(DoubleRange distressRange)
void	setDefaultSevereAlarmRange(DoubleRange severeRange)
void	setDefaultWarningAlarmRange(DoubleRange warningRange)
void	setDefaultWatchAlarmRange(DoubleRange watchRange)

Methods inherited from class org.yamcs.xtce.FloatDataType.Builder

setInitialValue, setSizeInBits, setValidRange

Methods inherited from class org.yamcs.xtce.BaseDataType.Builder

addAllUnits, addUnit, getEncoding, setBaseType, setEncoding, setInitialValue, setInitialValue

Methods inherited from class org.yamcs.xtce.NameDescription.Builder

getName, self, setAliasSet, setAncillaryData, setLongDescription, setName, setShortDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.yamcs.xtce.DataType.Builder

setInitialValue, setLongDescription, setName, setShortDescription

Methods inherited from interface org.yamcs.xtce.NumericParameterType.Builder

getEncoding, setEncoding

Constructor Detail

Builder

public Builder()

Builder

public Builder(FloatParameterType floatParameterType)

Method Detail

setContextAlarmList

public void setContextAlarmList(List<NumericContextAlarm> contextAlarmList)

Description copied from interface: NumericParameterType.Builder

Sets the contextual alarm list overriding any other contextual alarm if already set.

Specified by:

setContextAlarmList in interface NumericParameterType.Builder<FloatParameterType.Builder>

addContextAlarm

public void addContextAlarm(NumericContextAlarm nca)

addContextAlarms

public void addContextAlarms(Collection<NumericContextAlarm> ncas)

createOrGetAlarm

public NumericAlarm createOrGetAlarm(MatchCriteria contextMatch)

Specified by:

createOrGetAlarm in interface NumericParameterType.Builder<FloatParameterType.Builder>

getNumericContextAlarm

public NumericContextAlarm getNumericContextAlarm(MatchCriteria context)

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

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

build

public FloatParameterType build()

Specified by:

build in interface DataType.Builder<FloatParameterType.Builder>

Specified by:

build in interface NumericParameterType.Builder<FloatParameterType.Builder>

Specified by:

build in interface ParameterType.Builder<FloatParameterType.Builder>

setDefaultAlarm

public void setDefaultAlarm(NumericAlarm defaultAlarm)

Specified by:

setDefaultAlarm in interface NumericParameterType.Builder<FloatParameterType.Builder>