org.yamcs.xtce

Interface NumericParameterType

All Superinterfaces:

DataType, ParameterType

All Known Implementing Classes:

FloatParameterType, IntegerParameterType

public interface NumericParameterType
extends ParameterType

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
NumericAlarm	createOrGetAlarm(MatchCriteria contextMatch) Creates (if not already existing) and gets the alarm associated to the context.
NumericAlarm	getDefaultAlarm()
DataEncoding	getEncoding() Get the data encoding for the parameter type.
void	setContextAlarmList(List<NumericContextAlarm> contextAlarmList) Sets the contextual alarm list overriding any other contextual alarm if already set.
void	setDefaultAlarm(NumericAlarm defaultAlarm)

Methods inherited from interface org.yamcs.xtce.ParameterType

copy, getDependentParameters, hasAlarm, parseString, parseStringForRawValue, setEncoding

Methods inherited from interface org.yamcs.xtce.DataType

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

Method Detail

addAlarmRange

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

createOrGetAlarm

NumericAlarm createOrGetAlarm(MatchCriteria contextMatch)

Creates (if not already existing) and gets the alarm associated to the context.

Parameters:

contextMatch - use null for the default context

Returns:

getEncoding

DataEncoding getEncoding()

Description copied from interface: ParameterType

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

Specified by:

getEncoding in interface ParameterType

Returns:

getDefaultAlarm

NumericAlarm getDefaultAlarm()

setDefaultAlarm

void setDefaultAlarm(NumericAlarm defaultAlarm)

setContextAlarmList

void setContextAlarmList(List<NumericContextAlarm> contextAlarmList)

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

Parameters:

contextAlarmList -