Package org.yamcs.xtce
Class ParameterInstanceRef
java.lang.Object
org.yamcs.xtce.ParameterOrArgumentRef
org.yamcs.xtce.ParameterInstanceRef
- All Implemented Interfaces:
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/array 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
- See Also:
-
Field Summary
Fields inherited from class org.yamcs.xtce.ParameterOrArgumentRef
path, useCalibratedValue
-
Constructor Summary
ConstructorDescriptionConstructor to be used when the parameter is not yet known.ParameterInstanceRef
(boolean useCalibratedValue) ParameterInstanceRef
(Parameter para, boolean useCalibratedValue) ParameterInstanceRef
(Parameter para, PathElement[] path) -
Method Summary
Modifier and TypeMethodDescriptionint
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.getName()
void
setInstance
(int instance) void
setParameter
(Parameter para) toString()
Methods inherited from class org.yamcs.xtce.ParameterOrArgumentRef
getMemberPath, setMemberPath, setUseCalibratedValue, useCalibratedValue
-
Constructor Details
-
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
-
ParameterInstanceRef
-
ParameterInstanceRef
-
ParameterInstanceRef
public ParameterInstanceRef(boolean useCalibratedValue)
-
-
Method Details
-
setParameter
-
getParameter
-
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
-
getDataType
- Specified by:
getDataType
in classParameterOrArgumentRef
-
getName
- Specified by:
getName
in classParameterOrArgumentRef
-
toString
-