Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## uchicago.src.sim.parameter.rpl
Class AbstractDynamicParameter

    java.lang.Object
      uchicago.src.sim.parameter.rpl.AbstractRPLParameter
          uchicago.src.sim.parameter.rpl.AbstractDynamicParameter

All Implemented Interfaces:
  RPLParameter

Direct Known Subclasses:
  BlockRPLParameter, ListRPLParameter, NumericRPLParameter

    public abstract class AbstractDynamicParameter

extends AbstractRPLParameter

Defines common behavior for Dynamic RPLParameters.

Version:
  $Revision: 1.3 $ $Date: 2003/04/10 15:57:47 $

Field Summary

Fields inherited from class uchicago.src.sim.parameter.rpl.AbstractRPLParameter
`childConsts, childParams, convertor, curIndex, getMethod, name, setMethod, type`

Constructor Summary
`AbstractDynamicParameter(java.lang.String name)` Creates a AbstractDynamicParameter with the specified name.

Method Summary
`void` | `addToParent(RPLParameter parent)` Adds this AbstractDynamicParameter to the specified parent.
`protected abstract boolean` | `incrementSelf()` Increments this AbstractDynamicParameter only.
`boolean` | `next()` Increments the value of this RPLParameter to the "next" value.
`void` | `reset()` Resets this AbstractDynamicParameter to its initial value.

Methods inherited from class uchicago.src.sim.parameter.rpl.AbstractRPLParameter
`addChildConstant, addChildParameter, constantIterator, getName, getValue, getValue, invokeSet, parameterIterator, setModelParameter`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### AbstractDynamicParameter

    public AbstractDynamicParameter(java.lang.String name)

  Creates a AbstractDynamicParameter with the specified name.

  Parameters:
    `name` - the name of the parameter.

Method Detail

### addToParent

    public void addToParent(RPLParameter parent)

  Adds this AbstractDynamicParameter to the specified parent. This calls `parent.addChildDynamic`.

  Parameters:
    `parent` - the parent RPLParameter to add this as a child

### next

    public boolean next()

  Increments the value of this RPLParameter to the "next" value.

  Returns:
    true if the increment was successful otherwise false.

### reset

    public void reset()

  Resets this AbstractDynamicParameter to its initial value.

### incrementSelf

    protected abstract boolean incrementSelf()

  Increments this AbstractDynamicParameter only. This should not increment this parameter's children.

  Returns:
    true if the increment was successful (i.e. there was a "next" value), otherwise false.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD