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 ArrayParameterRefEntryType, NameReferenceType and ArrayDataType.

Author:

nm

See Also:

Serialized Form

Field Summary

Fields inherited from class org.yamcs.xtce.NameDescription

name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors

Constructor and Description
ArrayParameterType(ArrayParameterType t)
ArrayParameterType(String name)

Method Summary

Modifier and Type	Method and Description
ArrayParameterType	copy() Create a shallow copy of the parameter type - the object itself (and the primitive fields) are new but the other fields reference to the same object like the original
String	getTypeAsString() String which represents the type.
boolean	hasAlarm() Whether this ParameterType has any alarms associated
Object	parseString(String stringValue) parses the string into a java object according to the parameter type
Object	parseStringForRawValue(String stringValue) parses the string into a java object according to the parameter encoding
void	setEncoding(DataEncoding dataEncoding) set the data encoding for the parameter type
void	setInitialValue(String initialValue) Sets the initial value converting from string to the specific type value

Methods inherited from class org.yamcs.xtce.ArrayDataType

getElementType, getNumberOfDimensions, getValueType, setElementType, setNumberOfDimensions

Methods inherited from class org.yamcs.xtce.NameDescription

addAlias, addAliases, addAncillaryData, getAlias, getAliasSet, getAncillaryData, getAncillaryDataSet, getLongDescription, getName, getName, getOpsName, getQualifiedName, getShortDescription, getSubsystemName, getSubsystemName, setAliasSet, 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.ParameterType

getDependentParameters

Methods inherited from interface org.yamcs.xtce.DataType

getName, getValueType

Constructor Detail

ArrayParameterType

public ArrayParameterType(String name)

ArrayParameterType

public ArrayParameterType(ArrayParameterType t)

Method Detail

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

parseString

public Object parseString(String stringValue)

Description copied from interface: ParameterType

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

Specified by:

parseString in interface ParameterType

Returns:

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:

setEncoding

public void setEncoding(DataEncoding dataEncoding)

Description copied from interface: ParameterType

set the data encoding for the parameter type

Specified by:

setEncoding in interface ParameterType

copy

public ArrayParameterType copy()

Description copied from interface: ParameterType

Create a shallow copy of the parameter type - the object itself (and the primitive fields) are new but the other fields reference to the same object like the original

Specified by:

copy in interface ParameterType

Returns:

setInitialValue

public void setInitialValue(String initialValue)

Description copied from interface: DataType

Sets the initial value converting from string to the specific type value

Specified by:

setInitialValue in interface DataType

Overrides:

setInitialValue in class ArrayDataType