org.yamcs.xtce

Class EnumeratedParameterType.Builder

java.lang.Object

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

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

org.yamcs.xtce.EnumeratedDataType.Builder<EnumeratedParameterType.Builder>

org.yamcs.xtce.EnumeratedParameterType.Builder

All Implemented Interfaces:

DataType.Builder<EnumeratedParameterType.Builder>, ParameterType.Builder<EnumeratedParameterType.Builder>

Enclosing class:

EnumeratedParameterType

public static class EnumeratedParameterType.Builder
extends EnumeratedDataType.Builder<EnumeratedParameterType.Builder>
implements ParameterType.Builder<EnumeratedParameterType.Builder>

Field Summary

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

enumerationList, ranges

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

baseType, initialValue

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(EnumeratedParameterType enumeratedParameterType)

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)
EnumeratedParameterType	build()
EnumerationAlarm	createOrGetAlarm(MatchCriteria contextMatch)
EnumerationContextAlarm	getContextAlarm(MatchCriteria contextMatch)
EnumerationAlarm	getDefaultAlarm()
void	setContextAlarmList(List<EnumerationContextAlarm> contextAlarmList)
void	setDefaultAlarm(EnumerationAlarm enumerationAlarm)

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

addEnumerationRange, addEnumerationValue, addEnumerationValue, enumValue, enumValue, hasLabel

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.ParameterType.Builder

setEncoding

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

setInitialValue, setLongDescription, setName, setShortDescription

Constructor Detail

Builder

public Builder()

Builder

public Builder(EnumeratedParameterType enumeratedParameterType)

Method Detail

setDefaultAlarm

public void setDefaultAlarm(EnumerationAlarm enumerationAlarm)

addContextAlarm

public void addContextAlarm(EnumerationContextAlarm nca)

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)

getDefaultAlarm

public EnumerationAlarm getDefaultAlarm()

getContextAlarm

public EnumerationContextAlarm getContextAlarm(MatchCriteria contextMatch)

setContextAlarmList

public void setContextAlarmList(List<EnumerationContextAlarm> contextAlarmList)

build

public EnumeratedParameterType build()

Specified by:

build in interface DataType.Builder<EnumeratedParameterType.Builder>

Specified by:

build in interface ParameterType.Builder<EnumeratedParameterType.Builder>