Package org.yamcs.xtce

Class ArrayDataType

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.ArrayDataType

All Implemented Interfaces:

Serializable, DataType

Direct Known Subclasses:

ArrayArgumentType, ArrayParameterType

public class ArrayDataType
extends NameDescription
implements DataType

An array of values of the type referenced in type and have the number of array dimensions as specified in numberOfDimensions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArrayDataType.Builder<T extends ArrayDataType.Builder<T>>

Field Summary

Fields inherited from class org.yamcs.xtce.NameDescription

ancillaryData, name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors

Constructor	Description
ArrayDataType(String name, int numberOfDimensions)
ArrayDataType(ArrayDataType t)
ArrayDataType(ArrayDataType.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
IntegerValue	getDimension(int n)	Get the size of the nth dimension
DataType	getElementType()	returns the type of the elements of the array
int[]	getFixedSize()	If isFixedSize() returns true, this method can be used to get the array flat size
Object[]	getInitialValue()	Get the initial value if any
int	getNumberOfDimensions()
List<IntegerValue>	getSize()	Return the dimension list (defined as from XTCE 1.2).
String	getTypeAsString()	String which represents the type.
Yamcs.Value.Type	getValueType()	Return the expected Value type of an engineering value conforming to this XTCE data type
boolean	isFixedSize()
Object[]	parseString(String stringValue)	Parse an initial value specified as an json array.
Object	parseStringForRawValue(String stringValue)	parses the string into a java object according to the parameter encoding
String	toString(Object v)	Converts a value to a string.

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, toString, wait, wait, wait

Methods inherited from interface org.yamcs.xtce.DataType

getLongDescription, getName, getQualifiedName, getShortDescription

Constructor Detail

ArrayDataType

public ArrayDataType(ArrayDataType.Builder<?> builder)

ArrayDataType

public ArrayDataType(String name,
                     int numberOfDimensions)

ArrayDataType

public ArrayDataType(ArrayDataType t)

Method Detail

getElementType

public DataType getElementType()

returns the type of the elements of the array

Returns:

- the type of the elements of the array

getNumberOfDimensions

public int getNumberOfDimensions()

getValueType

public Yamcs.Value.Type getValueType()

Description copied from interface: DataType

Return the expected Value type of an engineering value conforming to this XTCE data type

Specified by:

getValueType in interface DataType

Returns:

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

Returns:

getSize

public List<IntegerValue> getSize()

Return the dimension list (defined as from XTCE 1.2). The list here is not really used except for populating the ArrayParameterEntry.dim at the MDB load.

Returns:

isFixedSize

public boolean isFixedSize()

Returns:

true if all dimensions are of fixed size

getDimension

public IntegerValue getDimension(int n)

Get the size of the nth dimension

getFixedSize

public int[] getFixedSize()

If isFixedSize() returns true, this method can be used to get the array flat size

Returns:

parseString

public Object[] parseString(String stringValue)

Parse an initial value specified as an json array. Each element of the array has to be itself an array until reaching the getNumberOfDimensions()

The return is an java array (Object[]). For multi dimensional arrays each Object it itself an Object[] and so on to reach the number of dimensions,

The final Object is of type as returned by the element type DataType.parseString(String)

Specified by:

parseString in interface DataType

Returns:

- a java object representation

parseStringForRawValue

public Object parseStringForRawValue(String stringValue)

Description copied from interface: DataType

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

Specified by:

parseStringForRawValue in interface DataType

Returns:

a java object representation

toString

public String toString(Object v)

Description copied from interface: DataType

Converts a value to a string. This should be the reverse of DataType.parseString(String).

Specified by:

toString in interface DataType

Returns:

getInitialValue

public Object[] getInitialValue()

Description copied from interface: DataType

Get the initial value if any

Specified by:

getInitialValue in interface DataType

Returns: