Package org.yamcs.xtce
Class InputParameter
java.lang.Object
org.yamcs.xtce.InputParameter
- All Implemented Interfaces:
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:
-
Constructor Summary
ConstructorDescriptionInputParameter
(ArgumentInstanceRef argumentRef, String inputName) InputParameter
(ParameterInstanceRef parameterInstance) InputParameter
(ParameterInstanceRef parameterInstance, String inputName) -
Method Summary
Modifier and TypeMethodDescriptionReturns the name of the input to be used in the algorithm.getRef()
boolean
void
setInputName
(String inputName) void
setMandatory
(boolean mandatory) toString()
-
Constructor Details
-
InputParameter
-
InputParameter
-
InputParameter
-
-
Method Details
-
getParameterInstance
- Returns:
- the reference to the parameter or null if this references an argument instead
-
getArgumentRef
- Returns:
- the reference to the command argument or null if this references a parameter instead
-
getRef
-
getInputName
-
getEffectiveInputName
Returns the name of the input to be used in the algorithm. This is the defined name as returned bygetInputName()
or the name of the parameter if no specific name has been defined. -
setInputName
-
isMandatory
public boolean isMandatory() -
setMandatory
public void setMandatory(boolean mandatory) -
toString
-