XPRMParameter

Method Detail

• getDescription

  public abstract java.lang.String getDescription()

  Get parameter description. Module parameters may provide a textual description of their functionality.

  Returns:

  description of the parameter or null if no description is available

• getValue

  public abstract XPRMValue getValue()

  Get current value. Value of parameters are available only after the model has been executed.

  Returns:

  current value of the parameter

• getValue

  public abstract XPRMValue getValue(XPRMModel m)

  Get current value for the given model. Module parameters may have a different value for each model.

  Parameters:

  m - model reference

  Returns:

  current value of the parameter

• isWriteable

  public boolean isWriteable()

  Check whether the parameter is writeable. This method applies only to module parameters (model parameters are all writeable).

  Returns:

  true if the module parameter can be modified using setparam

• isReadable

  public boolean isReadable()

  Check whether the parameter is readable. This method applies only to module parameters (model parameters are all readable).

  Returns:

  true if the module parameter can be read using getparam

• getStructCode

  public int getStructCode()

  Description copied from interface: XPRMTyped
  Structure code. The code is one of the STR_* values.

  Returns:

  Encoded structure

• getStructName

  public java.lang.String getStructName()

  Description copied from interface: XPRMTyped
  String representation of structure.

  Returns:

  Structure name

• getTypeCode

  public final int getTypeCode()

  Description copied from interface: XPRMTyped
  Type code. The code is one of the TYP_* values.

  Specified by:

  getTypeCode in interface  XPRMTyped

  Returns:

  Encoded type

• getTypeName

  public java.lang.String getTypeName()

  Description copied from interface: XPRMTyped
  String representation of type.

  Specified by:

  getTypeName in interface  XPRMTyped

  Returns:

  Type name

• getName

  public java.lang.String getName()

  Description copied from interface: XPRMIdentifier
  Get the identifier name.

  Specified by:

  getName in interface  XPRMIdentifier

  Returns:

  The identifier name