org.jactr.modules.pm

Class AbstractPerceptualModule

java.lang.Object

org.jactr.core.utils.DefaultAdaptable

org.jactr.core.module.AbstractModule

org.jactr.core.module.asynch.AbstractAsynchronousModule

org.jactr.modules.pm.AbstractPerceptualModule

All Implemented Interfaces:

IAsynchronousModule, IModule, IAdaptable, IInitializable, IInstallable, IParameterized, IPerceptualModule

Direct Known Subclasses:

AbstractAuralModule, AbstractMotorModule, AbstractVisualModule, AbstractVocalModule

public abstract class AbstractPerceptualModule
extends AbstractAsynchronousModule
implements IPerceptualModule, IParameterized, IAsynchronousModule

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	LOGGER logger definition

Fields inherited from interface org.jactr.modules.pm.IPerceptualModule

GREATER_THAN_CURRENT_CHUNK, HIGHEST_CHUNK, LESS_THAN_CURRENT_CHUNK, LOWEST_CHUNK

Fields inherited from interface org.jactr.core.module.asynch.IAsynchronousModule

STRICT_SYNCHRONIZATION_PARAM

Constructor Summary

Constructors

Constructor and Description
AbstractPerceptualModule(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected void	connectToCommonReality() called immediately after common reality connection has been established.
protected void	disconnectFromCommonReality() called on model termination to give modules a chance to remove their listeners
void	dispose() release any resources.
IChunk	getBusyChunk()
java.util.concurrent.Executor	getCommonRealityExecutor() return the executor that should shared by all common reality listeners.
IChunk	getErrorChunk()
java.util.concurrent.Executor	getExecutor() default executor INLINE_EXECUTOR is used
IChunk	getFreeChunk()
protected IChunk	getNamedChunk(java.lang.String name) utility to snag a named chunk from DM
protected IChunkType	getNamedChunkType(java.lang.String name)
IChunk	getRequestedChunk()
ISymbolGrounder	getSymbolGrounder() returns the shared symbol grounder.
IChunk	getUnrequestedChunk()
void	initialize() this will be called after all the modules have been installed permitting the module to attach listeners to other modules.
void	setSymbolGrounder(ISymbolGrounder grounder) set the symbol grounder for this module and, if it can, set it for all the other installed perceptual modules

Methods inherited from class org.jactr.core.module.asynch.AbstractAsynchronousModule

getParameter, getPossibleParameters, getSetableParameters, isStrictSynchronizationEnabled, setParameter, setStrictSynchronizationEnabled, synchronizedTimedEvent

Methods inherited from class org.jactr.core.module.AbstractModule

createBuffers, delayedFuture, delayedFuture, getModel, getName, getSafeName, immediateFuture, immediateReturn, install, setExecutor, uninstall

Methods inherited from class org.jactr.core.utils.DefaultAdaptable

addAdapterFactory, getAdapter, removeAdapterFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jactr.core.module.asynch.IAsynchronousModule

isStrictSynchronizationEnabled, setStrictSynchronizationEnabled, synchronizedTimedEvent

Methods inherited from interface org.jactr.core.module.IModule

getModel, getName, install, reset

Methods inherited from interface org.jactr.core.utils.IInstallable

uninstall

Methods inherited from interface org.jactr.core.utils.IAdaptable

getAdapter

Methods inherited from interface org.jactr.core.utils.parameter.IParameterized

getParameter, getPossibleParameters, getSetableParameters, setParameter

Field Detail

LOGGER

public static final org.apache.commons.logging.Log LOGGER

logger definition

Constructor Detail

AbstractPerceptualModule

public AbstractPerceptualModule(java.lang.String name)

Method Detail

getSymbolGrounder

public ISymbolGrounder getSymbolGrounder()

Description copied from interface: IPerceptualModule

returns the shared symbol grounder. In order to do cross-modal linkages correctly all modules should use the same grounder.

Specified by:

getSymbolGrounder in interface IPerceptualModule

Returns:

setSymbolGrounder

public void setSymbolGrounder(ISymbolGrounder grounder)

set the symbol grounder for this module and, if it can, set it for all the other installed perceptual modules

Specified by:

setSymbolGrounder in interface IPerceptualModule

Parameters:

grounder -

connectToCommonReality

protected void connectToCommonReality()

called immediately after common reality connection has been established. This is used to connect various listeners to the IAgent so that the model can be aware of different IAfferentObject and IEfferentObjects

disconnectFromCommonReality

protected void disconnectFromCommonReality()

called on model termination to give modules a chance to remove their listeners

initialize

public void initialize()

Description copied from interface: IModule

this will be called after all the modules have been installed permitting the module to attach listeners to other modules. if you want to get access to chunks,types, or productions before the model runs, attach a model listener and do that during the modelStarted call

Specified by:

initialize in interface IModule

Specified by:

initialize in interface IInitializable

Specified by:

initialize in class AbstractModule

dispose

public void dispose()

Description copied from interface: IModule

release any resources. this should only be called by the model during its own dispose method (assuming that this module is still installed) and should not result in the propogation of ANY events. The module should dispose of all its resources, including buffers

Specified by:

dispose in interface IModule

Overrides:

dispose in class AbstractModule

getCommonRealityExecutor

public java.util.concurrent.Executor getCommonRealityExecutor()

return the executor that should shared by all common reality listeners. this call is only valid after common reality has been connected

Specified by:

getCommonRealityExecutor in interface IPerceptualModule

Returns:

getExecutor

public java.util.concurrent.Executor getExecutor()

Description copied from class: AbstractModule

default executor INLINE_EXECUTOR is used

Specified by:

getExecutor in interface IAsynchronousModule

Overrides:

getExecutor in class AbstractModule

getNamedChunk

protected IChunk getNamedChunk(java.lang.String name)

utility to snag a named chunk from DM

Parameters:

name -

Returns:

getNamedChunkType

protected IChunkType getNamedChunkType(java.lang.String name)

getFreeChunk

public IChunk getFreeChunk()

getErrorChunk

public IChunk getErrorChunk()

getBusyChunk

public IChunk getBusyChunk()

getRequestedChunk

public IChunk getRequestedChunk()

getUnrequestedChunk

public IChunk getUnrequestedChunk()