Class Parameter

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
SystemParameter

public class Parameter extends NameDescription
A Parameter is a description of something that can have a value; it is not the value itself.
See Also:
  • Constructor Details

    • Parameter

      public Parameter(String name)
  • Method Details

    • getDataSource

      public DataSource getDataSource()
    • setDataSource

      public void setDataSource(DataSource dataSource)
    • setParameterType

      public void setParameterType(ParameterType pm)
    • getParameterType

      public ParameterType getParameterType()
    • getRecordingGroup

      public String getRecordingGroup()
    • setRecordingGroup

      public void setRecordingGroup(String g)
    • getInitialValue

      public Object getInitialValue()
      Returns:
      the initial value of the parameter (if any)
    • setInitialValue

      public void setInitialValue(Object initialValue)
      Sets the initial value for the parameter (if any). The value has to be compatible with its type.
      Parameters:
      initialValue -
    • isCommandParameter

      public boolean isCommandParameter()
      Return true if this parameter is used/valid in a commanding context: that is if the data source is DataSource.COMMAND or DataSource.COMMAND_HISTORY
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • isPersistent

      public boolean isPersistent()
    • setPersistent

      public void setPersistent(boolean persistent)
      If set, the parameter's value will be preserved during Yamcs restarts