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 classAggregateParameterType.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataEncodinggetEncoding()Get the data encoding for the parameter type.booleanhasAlarm()Whether this ParameterType has any alarms associatedObjectparseStringForRawValue(String stringValue)parses the string into a java object according to the parameter encodingAggregateParameterType.BuildertoBuilder()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:ParameterTypeWhether this ParameterType has any alarms associated- Specified by:
hasAlarmin interfaceParameterType
-
parseStringForRawValue
public Object parseStringForRawValue(String stringValue)
Description copied from interface:ParameterTypeparses the string into a java object according to the parameter encoding- Specified by:
parseStringForRawValuein interfaceParameterType- Returns:
-
toBuilder
public AggregateParameterType.Builder toBuilder()
Description copied from interface:ParameterTypeCreate a builder that can be used to make shallow copy of the parameter typeall the fields reference to the same object like the original
- Specified by:
toBuilderin interfaceParameterType- Returns:
-
getEncoding
public DataEncoding getEncoding()
Description copied from interface:ParameterTypeGet the data encoding for the parameter type.
For arrays and aggregates types that do not have encoding; this operation will throw anUnsupportedOperationException- Specified by:
getEncodingin interfaceParameterType- Returns:
-
-