org.jactr.tools.misc

Class ModelsLock

java.lang.Object

org.jactr.core.model.event.ModelListenerAdaptor

org.jactr.tools.misc.ModelsLock

All Implemented Interfaces:

java.util.EventListener, IModelListener, IInitializable, IInstallable, IInstrument

public class ModelsLock
extends ModelListenerAdaptor
implements IInstrument

locking mechanism, that when closed, will block all the models it is installed into.

Author:

harrison

Constructor Summary

Constructors

Constructor and Description
ModelsLock()

Method Summary

Modifier and Type	Method and Description
boolean	allAreBlocked()
boolean	allAreFree()
protected void	checkAndBlock(IModel model) do the blocking.
java.util.concurrent.Future<java.lang.Boolean>	close() close the lock on all the installed models.
void	cycleStarted(ModelEvent me) called at the start of each cycle.
void	initialize() perform any dependent initialization.
void	install(IModel model) Description of the Method
boolean	isClosed() returns true if the gate is closed, but not necessarily if everyone is.
void	modelStarted(ModelEvent me) called once the model has started its execution.
void	modelStopped(ModelEvent me) called when the model's execution has completed.
java.util.concurrent.Future<java.lang.Boolean>	open() release the models.
void	uninstall(IModel model) Description of the Method

Methods inherited from class org.jactr.core.model.event.ModelListenerAdaptor

bufferInstalled, cycleStopped, exceptionThrown, extensionInstalled, instrumentInstalled, logEvent, modelConnected, modelDisconnected, modelInitialized, modelResumed, modelSuspended, moduleInstalled, parameterChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelsLock

public ModelsLock()

Method Detail

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

modelStarted

public void modelStarted(ModelEvent me)

Description copied from interface: IModelListener

called once the model has started its execution. this is called shortly after modelConnected

Specified by:

modelStarted in interface IModelListener

Overrides:

modelStarted in class ModelListenerAdaptor

modelStopped

public void modelStopped(ModelEvent me)

Description copied from interface: IModelListener

called when the model's execution has completed. this is always the second to last event. disconnected is the final one

Specified by:

modelStopped in interface IModelListener

Overrides:

modelStopped in class ModelListenerAdaptor

cycleStarted

public void cycleStarted(ModelEvent me)

Description copied from interface: IModelListener

called at the start of each cycle.

Specified by:

cycleStarted in interface IModelListener

Overrides:

cycleStarted in class ModelListenerAdaptor

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

isClosed

public boolean isClosed()

returns true if the gate is closed, but not necessarily if everyone is.

Returns:

allAreFree

public boolean allAreFree()

allAreBlocked

public boolean allAreBlocked()

close

public java.util.concurrent.Future<java.lang.Boolean> close()

close the lock on all the installed models. To block until all the models, just call Future.get(). The return boolean will be true, unless there are no models. i.e., If no models are running, it will return false.

Returns:

open

public java.util.concurrent.Future<java.lang.Boolean> open()

release the models.

Returns:

checkAndBlock

protected void checkAndBlock(IModel model)

do the blocking.

Parameters:

model -