org.jactr.tools.throttle

Class RuntimeThrottler

java.lang.Object

org.jactr.tools.throttle.RuntimeThrottler

All Implemented Interfaces:

IInitializable, IInstallable, IParameterized, IInstrument

public class RuntimeThrottler
extends java.lang.Object
implements IInstrument, IParameterized

simple runtime throttler. Attaches to a model and ensure that the full model cycle takes at least MinimumCycleRealTime seconds.

Author:

harrison

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MINIMUM_CYCLE_TIME

Constructor Summary

Constructors

Constructor and Description
RuntimeThrottler()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getParameter(java.lang.String key) return parameter value - null if not defined.
java.util.Collection<java.lang.String>	getPossibleParameters() Return all parameters that can be read
java.util.Collection<java.lang.String>	getSetableParameters() Return list of all parameters that can be set.
void	initialize() perform any dependent initialization.
void	install(IModel model) Description of the Method
void	setParameter(java.lang.String key, java.lang.String value) Set the named parameter
void	uninstall(IModel model) Description of the Method

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MINIMUM_CYCLE_TIME

public static final java.lang.String MINIMUM_CYCLE_TIME

See Also:

Constant Field Values

Constructor Detail

RuntimeThrottler

public RuntimeThrottler()

Method Detail

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

Description copied from interface: IParameterized

Set the named parameter

Specified by:

setParameter in interface IParameterized

getParameter

public java.lang.String getParameter(java.lang.String key)

Description copied from interface: IParameterized

return parameter value - null if not defined.

Specified by:

getParameter in interface IParameterized

Parameters:

key - Description of the Parameter

Returns:

The parameter value

getPossibleParameters

public java.util.Collection<java.lang.String> getPossibleParameters()

Description copied from interface: IParameterized

Return all parameters that can be read

Specified by:

getPossibleParameters in interface IParameterized

Returns:

The possibleParameters value

getSetableParameters

public java.util.Collection<java.lang.String> getSetableParameters()

Description copied from interface: IParameterized

Return list of all parameters that can be set.

Specified by:

getSetableParameters in interface IParameterized

Returns:

The setableParameters value

install

public void install(IModel model)

Description copied from interface: IInstrument

Description of the Method

Specified by:

install in interface IInstallable

Specified by:

install in interface IInstrument

Parameters:

model - Description of the Parameter

uninstall

public void uninstall(IModel model)

Description copied from interface: IInstrument

Description of the Method

Specified by:

uninstall in interface IInstallable

Specified by:

uninstall in interface IInstrument

Parameters:

model - Description of the Parameter

initialize

public void initialize()

Description copied from interface: IInstrument

perform any dependent initialization. this is called before the model starts, on the model thread. All model data will be available at this time. this method should excecute as quickly as possible so that all the model can start running sooner. Any long running actions should likely be started during install and harvested by initialize()

Specified by:

initialize in interface IInitializable

Specified by:

initialize in interface IInstrument