Package org.yamcs.xtce

Class AggregateParameterType

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.AggregateDataType

org.yamcs.xtce.AggregateParameterType

All Implemented Interfaces:

Serializable, DataType, ParameterType

public class AggregateParameterType
extends AggregateDataType
implements ParameterType

AggegateParameters are analogous to a C struct, they are an aggregation of related data items. Each of these data items is defined here as a 'Member'

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AggregateParameterType.Builder

Field Summary

Fields inherited from class org.yamcs.xtce.NameDescription

ancillaryData, name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors

Constructor	Description
AggregateParameterType(String name)
AggregateParameterType(AggregateParameterType t)
AggregateParameterType(AggregateParameterType.Builder builder)

Method Summary

Modifier and Type	Method	Description
DataEncoding	getEncoding()	Get the data encoding for the parameter type.
boolean	hasAlarm()	Whether this ParameterType has any alarms associated
Object	parseStringForRawValue(String stringValue)	parses the string into a java object according to the parameter encoding
AggregateParameterType.Builder	toBuilder()	Create a builder that can be used to make shallow copy of the parameter type

Methods inherited from class org.yamcs.xtce.AggregateDataType

getInitialValue, getMember, getMember, getMember, getMemberList, getMemberNames, getTypeAsString, getValueType, numMembers, parseString, toString

Methods inherited from class org.yamcs.xtce.NameDescription

addAlias, addAliases, addAncillaryData, getAlias, getAliasSet, getAncillaryData, getLongDescription, getName, getName, getOpsName, getQualifiedName, getShortDescription, getSubsystemName, getSubsystemName, setAliasSet, setAncillaryData, setLongDescription, setName, setQualifiedName, 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

getInitialValue, getLongDescription, getName, getShortDescription, getTypeAsString, getValueType, toString

Methods inherited from interface org.yamcs.xtce.ParameterType

getDependentParameters, parseString

Constructor Detail

AggregateParameterType

public AggregateParameterType(AggregateParameterType.Builder builder)

AggregateParameterType

public AggregateParameterType(String name)

AggregateParameterType

public AggregateParameterType(AggregateParameterType t)

Method Detail

hasAlarm

public boolean hasAlarm()

Description copied from interface: ParameterType

Whether this ParameterType has any alarms associated

Specified by:

hasAlarm in interface ParameterType

parseStringForRawValue

public Object parseStringForRawValue(String stringValue)

Description copied from interface: ParameterType

parses the string into a java object according to the parameter encoding

Specified by:

parseStringForRawValue in interface ParameterType

Returns:

toBuilder

public AggregateParameterType.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:

getEncoding

public 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: