Package repast.simphony.parameter

Interface Parameters

All Superinterfaces:
Cloneable
All Known Subinterfaces:
MutableParameters
All Known Implementing Classes:
AbstractParameters, BeanParameters, BoundParameters, DefaultParameters, EmptyParameters
public interface Parameters extends Cloneable
Encapsulates simulation time model parameters.
Author:
Nick Collier

  • Field Details

    • NULL

      static final Object NULL

  • Method Details

    • addPropertyChangeListener

      void addPropertyChangeListener(PropertyChangeListener listener)
      Adds listener that will listen for parameter changes on this Parameters.
      Parameters:
      listener -

    • removePropertyChangeListener

      void removePropertyChangeListener(PropertyChangeListener listener)
      Removes the specified listener from the listeners listening to this Parameters object.
      Parameters:
      listener -

    • getSchema

      Schema getSchema()
      Gets the Schema for this Parameters object.
      Returns:
      the Schema for this Parameters object.

    • clone

      Parameters clone()
      Method to clone a Parameter object.
      Returns:
      a Parameter clone.

    • getValue

      Object getValue(String paramName)
      Gets the value associated with the specified parameter name.
      Parameters:
      paramName - the name of the parameter whose value we want
      Returns:
      the value associated with the specified parameter name.

    • getDouble

      Double getDouble(String paramName)
      Gets the Double value associated with the specified parameter name.
      Parameters:
      paramName - the name of the parameter whose value we want
      Returns:
      the value associated with the specified parameter name.

    • getInteger

      Integer getInteger(String paramName)
      Gets the Integer value associated with the specified parameter name.
      Parameters:
      paramName - the name of the parameter whose value we want
      Returns:
      the value associated with the specified parameter name.

    • getBoolean

      Boolean getBoolean(String paramName)
      Gets the Boolean value associated with the specified parameter name.
      Parameters:
      paramName - the name of the parameter whose value we want
      Returns:
      the value associated with the specified parameter name.

    • getString

      String getString(String paramName)
      Gets the String value associated with the specified parameter name.
      Parameters:
      paramName - the name of the parameter whose value we want
      Returns:
      the value associated with the specified parameter name.

    • getLong

      Long getLong(String paramName)
      Gets the Long value associated with the specified parameter name.
      Parameters:
      paramName - the name of the parameter whose value we want
      Returns:
      the value associated with the specified parameter name.

    • getFloat

      Float getFloat(String paramName)
      Gets the Float value associated with the specified parameter name.
      Parameters:
      paramName - the name of the parameter whose value we want
      Returns:
      the value associated with the specified parameter name.

    • getValueAsString

      String getValueAsString(String paramName)
      Gets a String representation of the specified parameter's value.
      Parameters:
      paramName - the name of the parameter
      Returns:
      a String representation of the specified parameters's value.

    • setValue

      void setValue(String paramName, Object val)
      Sets the specified parameter name to the specified value.
      Parameters:
      paramName - the name of the parameter to set to the new value
      val - the new value

    • isReadOnly

      boolean isReadOnly(String paramName)
      True if parameter is read only.
      Parameters:
      paramName - the name of the parameter
      Returns:
      true if parameter is read-only otherwise false.

    • getDisplayName

      String getDisplayName(String paramName)
      Gets the display name for the specified parameter name.
      Parameters:
      paramName - the parameter name
      Returns:
      the display name for the specified parameter name.