Package org.yamcs.xtce
Class ArrayParameterType
java.lang.Object
org.yamcs.xtce.NameDescription
org.yamcs.xtce.ArrayDataType
org.yamcs.xtce.ArrayParameterType
- All Implemented Interfaces:
Serializable
,DataType
,ParameterType
Describe an array parameter type. The size and number of dimensions are described here. See
ArrayParameterEntry
, NameReferenceType and ArrayDataType.
Note: XTCE 1.1 defines only the number of dimensions (integer) as part of the ArrayDataType and leaves the dimension
list (containing the size of each dimension) to be defined as part of the ArrayParameterEntry
In XTCE 1.2 the dimension list is also defined in this class and can be optionally omitted from the
ArrayParameterEntry
.
We support both behaviours.
- See Also:
-
Nested Class Summary
-
Field Summary
Fields inherited from class org.yamcs.xtce.NameDescription
ancillaryData, name, PATH_SEPARATOR, qualifiedName, xtceAliasSet
-
Constructor Summary
ConstructorDescriptionArrayParameterType
(String name) ArrayParameterType
(String name, int numberOfDimensions) -
Method Summary
Methods inherited from class org.yamcs.xtce.ArrayDataType
convertType, getDimension, getElementType, getFixedSize, getInitialValue, getNumberOfDimensions, getSize, getValueType, isFixedSize, parseStringForRawValue, toString
Methods inherited from class org.yamcs.xtce.NameDescription
addAlias, addAliases, addAncillaryData, getAlias, getAliasSet, getAncillaryData, getLongDescription, getName, getName, getOpsName, getQualifiedName, getShortDescription, getSubsystemName, getSubsystemName, qualifiedName, setAliasSet, setAncillaryData, setLongDescription, setName, setQualifiedName, setShortDescription
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.yamcs.xtce.DataType
convertType, getInitialValue, getLongDescription, getName, getQualifiedName, getShortDescription, getValueType, parseStringForRawValue, toString
Methods inherited from interface org.yamcs.xtce.ParameterType
getDependentParameters
-
Constructor Details
-
ArrayParameterType
-
ArrayParameterType
-
ArrayParameterType
-
ArrayParameterType
-
-
Method Details
-
getTypeAsString
Description copied from interface:DataType
String which represents the type. This string will be presented to the users of the system.- Specified by:
getTypeAsString
in interfaceDataType
- Overrides:
getTypeAsString
in classArrayDataType
- Returns:
-
hasAlarm
public boolean hasAlarm()Description copied from interface:ParameterType
Whether this ParameterType has any alarms associated- Specified by:
hasAlarm
in interfaceParameterType
-
toBuilder
Description copied from interface:ParameterType
Create 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:
toBuilder
in interfaceParameterType
- Returns:
-
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 anUnsupportedOperationException
- Specified by:
getEncoding
in interfaceParameterType
- Returns:
-
toString
-