Package repast.simphony.parameter

Interface MutableParameters

All Superinterfaces:

Cloneable, Parameters

All Known Implementing Classes:

BoundParameters, DefaultParameters

public interface MutableParameters
extends Parameters

Encapsulates a mutable set of simulation time model parameters.

Author:

Michelle Kehrer

Field Summary

Fields inherited from interface repast.simphony.parameter.Parameters

NULL

Method Summary

Modifier and Type	Method	Description
void	addConstraint(String name, List constrainingList)	Constains the value of the named to parameter to those in the list.
void	addConstraint(String name, SteppedRange constrainingRange)	Constrains the value of the named parameter to those in the specified range.
void	addConvertor(String name, StringConverter converter)	Adds a converter to convert the named parameter back and forth to a String.
void	addParameter(String name, String displayName, Class type, Object value, boolean isReadOnly)	Adds a parameter to this Parameters.
boolean	removeParameter(String name)	Removes the named parameter

Methods inherited from interface repast.simphony.parameter.Parameters

addPropertyChangeListener, clone, getBoolean, getDisplayName, getDouble, getFloat, getInteger, getLong, getSchema, getString, getValue, getValueAsString, isReadOnly, removePropertyChangeListener, setValue

Method Detail

addParameter

void addParameter(String name,
                  String displayName,
                  Class type,
                  Object value,
                  boolean isReadOnly)

Adds a parameter to this Parameters.

Parameters:

name - the name of the parameter

displayName - the display name for the parameter

type - the type of the parameter

value - the default value of the parameter

isReadOnly - whether or not the parameter is read only.

addConstraint

void addConstraint(String name,
                   List constrainingList)

Constains the value of the named to parameter to those in the list.

Parameters:

name - the name of the parameter

constrainingList - a list containing the possible values for the named parameter

addConvertor

void addConvertor(String name,
                  StringConverter converter)

Adds a converter to convert the named parameter back and forth to a String.

Parameters:

name - the name of the parameter

converter - the converter

addConstraint

void addConstraint(String name,
                   SteppedRange constrainingRange)

Constrains the value of the named parameter to those in the specified range.

Parameters:

name - the name of the parmaeter

constrainingRange - a range of the possible values for the named parameter

removeParameter

boolean removeParameter(String name)

Removes the named parameter

Parameters:

name - the name of the parameter

Returns:

whether or not removal was successful