Module org.yamcs.xtce

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

public class ArrayParameterType
extends ArrayDataType
implements 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:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArrayParameterType.Builder

Field Summary

Fields inherited from class org.yamcs.xtce.NameDescription

ancillaryData, name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors

Constructor	Description
ArrayParameterType(String name)
ArrayParameterType(String name, int numberOfDimensions)
ArrayParameterType(ArrayParameterType t)
ArrayParameterType(ArrayParameterType.Builder builder)

Method Summary

Modifier and Type	Method	Description
DataEncoding	getEncoding()	Get the data encoding for the parameter type.
String	getTypeAsString()	String which represents the type.
boolean	hasAlarm()	Whether this ParameterType has any alarms associated
ArrayParameterType.Builder	toBuilder()	Create a builder that can be used to make shallow copy of the parameter type
String	toString()

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

public ArrayParameterType(ArrayParameterType.Builder builder)

ArrayParameterType

public ArrayParameterType(String name)

ArrayParameterType

public ArrayParameterType(String name,
 int numberOfDimensions)

ArrayParameterType

public ArrayParameterType(ArrayParameterType t)

Method Details

getTypeAsString

public String 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 interface DataType

Overrides:

getTypeAsString in class ArrayDataType

Returns:

hasAlarm

public boolean hasAlarm()

Description copied from interface: ParameterType

Whether this ParameterType has any alarms associated

Specified by:

hasAlarm in interface ParameterType

toBuilder

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

toString

public String toString()

Overrides:

toString in class Object