org.yamcs.xtce

Class ParameterInstanceRef

java.lang.Object

org.yamcs.xtce.ParameterInstanceRef

All Implemented Interfaces:

Serializable

public class ParameterInstanceRef
extends Object
implements Serializable

A reference to an instance of a Parameter. Used when the value of a parameter is required for a calculation or as an index value. A positive value for instance is forward in time, a negative value for count is backward in time, a 0 value for count means use the current value of the parameter or the first value in a container. If the parameter is an aggregate or an array, the reference can be made to a member of the aggregate/arraty or more generally to a path inside the aggregate (if a hierarchy of aggregates/arrays) Thus the reference can be something like: g1/g2/a[1]/g4[a3]/p7

Author:

nm

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterInstanceRef() Constructor to be used when the parameter is not yet known.
ParameterInstanceRef(boolean useCalibratedValue)
ParameterInstanceRef(Parameter para)
ParameterInstanceRef(Parameter para, boolean useCalibratedValue)

Method Summary

Modifier and Type	Method and Description
int	getInstance() A positive value for instance is forward in time, a negative value for count is backward in time, a 0 value for count means use the current value of the parameter or the first value in a container.
PathElement[]	getMemberPath() If the parameter is an aggregate or an array (or a nested structure of these), return the path to the referenced member inside the structure.
Parameter	getParameter()
void	setInstance(int instance)
void	setMemberPath(PathElement[] path)
void	setParameter(Parameter para)
void	setUseCalibratedValue(boolean useCalibratedValue)
String	toString()
boolean	useCalibratedValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterInstanceRef

public ParameterInstanceRef()

Constructor to be used when the parameter is not yet known. The parameter will have to be set later with setParameter()

ParameterInstanceRef

public ParameterInstanceRef(Parameter para)

ParameterInstanceRef

public ParameterInstanceRef(Parameter para,
                            boolean useCalibratedValue)

ParameterInstanceRef

public ParameterInstanceRef(boolean useCalibratedValue)

Method Detail

setParameter

public void setParameter(Parameter para)

getParameter

public Parameter getParameter()

useCalibratedValue

public boolean useCalibratedValue()

setUseCalibratedValue

public void setUseCalibratedValue(boolean useCalibratedValue)

setInstance

public void setInstance(int instance)

getInstance

public int getInstance()

A positive value for instance is forward in time, a negative value for count is backward in time, a 0 value for count means use the current value of the parameter or the first value in a container.

Returns:

instance of the parameter that is required

getMemberPath

public PathElement[] getMemberPath()

If the parameter is an aggregate or an array (or a nested structure of these), return the path to the referenced member inside the structure.

Returns:

the path to the referenced member of the aggregate or array or null if this reference refers to the parameter itself

setMemberPath

public void setMemberPath(PathElement[] path)

toString

public String toString()

Overrides:

toString in class Object