Package org.yamcs.xtce

Class InputParameter

java.lang.Object

org.yamcs.xtce.InputParameter

All Implemented Interfaces:

Serializable

public class InputParameter
extends Object
implements Serializable

Input parameters for algorithms.

Although they are called input parameters they can also reference command arguments for algorithms running part of command transmission constraints or command verifiers.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InputParameter(ArgumentInstanceRef argumentRef, String inputName)
InputParameter(ParameterInstanceRef parameterInstance)
InputParameter(ParameterInstanceRef parameterInstance, String inputName)

Method Summary

Modifier and Type	Method	Description
ArgumentInstanceRef	getArgumentRef()
String	getEffectiveInputName()	Returns the name of the input to be used in the algorithm.
String	getInputName()
ParameterInstanceRef	getParameterInstance()
ParameterOrArgumentRef	getRef()
boolean	isMandatory()
void	setInputName(String inputName)
void	setMandatory(boolean mandatory)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

InputParameter

public InputParameter(ParameterInstanceRef parameterInstance)

InputParameter

public InputParameter(ParameterInstanceRef parameterInstance,
 String inputName)

InputParameter

public InputParameter(ArgumentInstanceRef argumentRef,
 String inputName)

Method Details

getParameterInstance

public ParameterInstanceRef getParameterInstance()

Returns:

the reference to the parameter or null if this references an argument instead

getArgumentRef

public ArgumentInstanceRef getArgumentRef()

Returns:

the reference to the command argument or null if this references a parameter instead

getRef

public ParameterOrArgumentRef getRef()

getInputName

public String getInputName()

getEffectiveInputName

public String getEffectiveInputName()

Returns the name of the input to be used in the algorithm. This is the defined name as returned by getInputName() or the name of the parameter if no specific name has been defined.

setInputName

public void setInputName(String inputName)

isMandatory

public boolean isMandatory()

setMandatory

public void setMandatory(boolean mandatory)

toString

public String toString()

Overrides:

toString in class Object