org.yamcs.xtce

Class ArrayParameterEntry

java.lang.Object

org.yamcs.xtce.SequenceEntry

org.yamcs.xtce.ParameterEntry

org.yamcs.xtce.ArrayParameterEntry

All Implemented Interfaces:

Serializable, Comparable<SequenceEntry>

public class ArrayParameterEntry
extends ParameterEntry

Describe an entry that is an array parameter. The size of the extracted array has to be specified in the size property which is a list of IntegerValue that can be static or values of other parameters.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.yamcs.xtce.SequenceEntry

SequenceEntry.ReferenceLocationType

Field Summary

Fields inherited from class org.yamcs.xtce.SequenceEntry

container, locationInContainerInBits

Constructor Summary

Constructors

Constructor and Description
ArrayParameterEntry(int locationInContainerInBits, SequenceEntry.ReferenceLocationType location)
ArrayParameterEntry(int locationInContainerInBits, SequenceEntry.ReferenceLocationType location, Parameter parameter)

Method Summary

Modifier and Type	Method and Description
Parameter	getParameter()
List<IntegerValue>	getSize()
void	setParameter(Parameter parameter)
void	setSize(List<IntegerValue> list) sets the sizes of the extracted array.
String	toString()

Methods inherited from class org.yamcs.xtce.SequenceEntry

compareTo, getContainer, getIncludeCondition, getIndex, getLocationInContainerInBits, getReferenceLocation, getRepeatEntry, getSequenceContainer, setIncludeCondition, setLocation, setLocationInContainerInBits, setReferenceLocation, setRepeatEntry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArrayParameterEntry

public ArrayParameterEntry(int locationInContainerInBits,
                           SequenceEntry.ReferenceLocationType location)

ArrayParameterEntry

public ArrayParameterEntry(int locationInContainerInBits,
                           SequenceEntry.ReferenceLocationType location,
                           Parameter parameter)

Method Detail

setParameter

public void setParameter(Parameter parameter)

Overrides:

setParameter in class ParameterEntry

setSize

public void setSize(List<IntegerValue> list)

sets the sizes of the extracted array. The length of the list has to match the ArrayDataType.getNumberOfDimensions()

Throws:

IllegalArgumentException - if the length of the list is not correct.

getSize

public List<IntegerValue> getSize()

getParameter

public Parameter getParameter()

Overrides:

getParameter in class ParameterEntry

Returns:

the parameter referenced by this array entry

toString

public String toString()

Overrides:

toString in class ParameterEntry