org.jactr.modules.pm.visual

Class AbstractVisualModule

java.lang.Object

org.jactr.core.utils.DefaultAdaptable

org.jactr.core.module.AbstractModule

org.jactr.core.module.asynch.AbstractAsynchronousModule

org.jactr.modules.pm.AbstractPerceptualModule

org.jactr.modules.pm.visual.AbstractVisualModule

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultVisualModule6

public abstract class AbstractVisualModule
extends AbstractPerceptualModule
implements IVisualModule, IParameterized

abstract impl that address most of the trivial details. Clients must provide and configure the actual IVisualMemory used.

Author:

harrison

See Also:

http://jactr.org/node/137

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENABLE_BUFFER_STUFF_PARAM
static java.lang.String	ENCODING_TIME_EQUATION_PARAM
static java.lang.String	SEARCHING_TIME_EQUATION_PARAM

Fields inherited from interface org.jactr.modules.pm.visual.IVisualModule

ASSIGN_FINST_CHUNK_TYPE, ATTENDED_STATUS_SLOT, CLEAR_CHUNK_TYPE, COLOR_CHUNK_TYPE, COLOR_SLOT, CURRENT_CHUNK, CURSOR_CHUNK_TYPE, EMPTY_CHUNK_TYPE, GUI_CHUNK_TYPE, HEIGHT_SLOT, KIND_SLOT, LINE_CHUNK_TYPE, MOVE_ATTENTION_CHUNK_TYPE, NEAREST_SLOT, OBJECTS_SLOT, OVAL_CHUNK_TYPE, PHRASE_CHUNK_TYPE, SCREEN_POSITION_SLOT, SCREEN_X_SLOT, SCREEN_Y_SLOT, SCREEN_Z_SLOT, SIZE_SLOT, START_TRACKING_CHUNK_TYPE, TEXT_CHUNK_TYPE, TIME_STATUS_SLOT, TOKEN_SLOT, TYPE_SLOT, VALUE_SLOT, VISUAL_BUFFER, VISUAL_CHUNK_TYPE, VISUAL_COMMAND_CHUNK_TYPE, VISUAL_LOCATION_BUFFER, VISUAL_LOCATION_CHUNK_TYPE, WIDTH_SLOT

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
AbstractVisualModule()

Method Summary

Modifier and Type	Method and Description
void	addListener(IVisualModuleListener listener, java.util.concurrent.Executor executor)
protected void	applyParameters() we apply the parameters after the visual map has been created so that we can pass through some parameters
void	assignFINST(IChunk visualChunk)
protected void	connectToCommonReality() called immediately after common reality connection has been established.
protected java.util.Collection<IActivationBuffer>	createBuffers() called to create any buffers used by this buffer.
protected abstract IVisualActivationBuffer	createVisualActivationBuffer() called during install process
protected abstract IVisualLocationBuffer	createVisualLocationBuffer(IVisualActivationBuffer buffer) called during install process since models rely on only one status buffer, the visual location buffer should use the visual activation buffer.
protected abstract IVisualMemory	createVisualMemory()
protected void	disconnectFromCommonReality() called on model termination to give modules a chance to remove their listeners
void	dispatch(VisualModuleEvent event)
void	dispose() release any resources.
IChunk	getCurrentChunk()
IVisualEncodingTimeEquation	getEncodingTimeEquation()
IChunk	getGreaterThanCurrentChunk()
IChunk	getHighestChunk()
IChunk	getLessThanCurrentChunk()
IChunk	getLowestChunk()
java.lang.String	getParameter(java.lang.String key) return parameter value - null if not defined.
IPerceptualMemory	getPerceptualMemory()
IVisualSearchTimeEquation	getSearchTimeEquation()
java.util.Collection<java.lang.String>	getSetableParameters() Return list of all parameters that can be set.
IVisualActivationBuffer	getVisualActivationBuffer()
IChunkType	getVisualChunkType()
IVisualLocationBuffer	getVisualLocationBuffer()
IChunkType	getVisualLocationChunkType()
IVisualMemory	getVisualMemory() return the backing short-term iconic memory store
boolean	hasListeners()
void	initialize() this will be called after all the modules have been installed permitting the module to attach listeners to other modules.
void	removeListener(IVisualModuleListener listener)
protected void	setDefaultParameters()
void	setEncodingTimeEquation(IVisualEncodingTimeEquation equation)
void	setParameter(java.lang.String key, java.lang.String value) Set the named parameter
void	setSearchTimeEquation(IVisualSearchTimeEquation equation)

Methods inherited from class org.jactr.modules.pm.AbstractPerceptualModule

getBusyChunk, getCommonRealityExecutor, getErrorChunk, getExecutor, getFreeChunk, getNamedChunk, getNamedChunkType, getRequestedChunk, getSymbolGrounder, getUnrequestedChunk, setSymbolGrounder

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

getPossibleParameters, isStrictSynchronizationEnabled, setStrictSynchronizationEnabled, synchronizedTimedEvent

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

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.modules.pm.visual.IVisualModule

reset, setTrackedVisualChunk

Methods inherited from interface org.jactr.modules.pm.IPerceptualMemoryModule

attendTo, search

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

getCommonRealityExecutor, getSymbolGrounder, setSymbolGrounder

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

getExecutor, 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

getPossibleParameters

Field Detail

ENCODING_TIME_EQUATION_PARAM

public static final java.lang.String ENCODING_TIME_EQUATION_PARAM

See Also:

Constant Field Values

SEARCHING_TIME_EQUATION_PARAM

public static final java.lang.String SEARCHING_TIME_EQUATION_PARAM

See Also:

Constant Field Values

ENABLE_BUFFER_STUFF_PARAM

public static final java.lang.String ENABLE_BUFFER_STUFF_PARAM

See Also:

Constant Field Values

Constructor Detail

AbstractVisualModule

public AbstractVisualModule()

Method Detail

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 AbstractPerceptualModule

setDefaultParameters

protected void setDefaultParameters()

addListener

public void addListener(IVisualModuleListener listener,
                        java.util.concurrent.Executor executor)

Specified by:

addListener in interface IVisualModule

removeListener

public void removeListener(IVisualModuleListener listener)

Specified by:

removeListener in interface IVisualModule

hasListeners

public boolean hasListeners()

Specified by:

hasListeners in interface IVisualModule

dispatch

public void dispatch(VisualModuleEvent event)

Specified by:

dispatch in interface IVisualModule

createVisualLocationBuffer

protected abstract IVisualLocationBuffer createVisualLocationBuffer(IVisualActivationBuffer buffer)

called during install process since models rely on only one status buffer, the visual location buffer should use the visual activation buffer.

Returns:

createVisualActivationBuffer

protected abstract IVisualActivationBuffer createVisualActivationBuffer()

called during install process

Returns:

createVisualMemory

protected abstract IVisualMemory createVisualMemory()

getVisualLocationBuffer

public IVisualLocationBuffer getVisualLocationBuffer()

Specified by:

getVisualLocationBuffer in interface IVisualModule

getVisualActivationBuffer

public IVisualActivationBuffer getVisualActivationBuffer()

Specified by:

getVisualActivationBuffer in interface IVisualModule

createBuffers

protected java.util.Collection<IActivationBuffer> createBuffers()

Description copied from class: AbstractModule

called to create any buffers used by this buffer. They will be installed into the model by the install(IModel) call

Overrides:

createBuffers in class AbstractModule

Returns:

getLowestChunk

public IChunk getLowestChunk()

getHighestChunk

public IChunk getHighestChunk()

getLessThanCurrentChunk

public IChunk getLessThanCurrentChunk()

getGreaterThanCurrentChunk

public IChunk getGreaterThanCurrentChunk()

getCurrentChunk

public IChunk getCurrentChunk()

getSearchTimeEquation

public IVisualSearchTimeEquation getSearchTimeEquation()

Specified by:

getSearchTimeEquation in interface IVisualModule

setSearchTimeEquation

public void setSearchTimeEquation(IVisualSearchTimeEquation equation)

Specified by:

setSearchTimeEquation in interface IVisualModule

getEncodingTimeEquation

public IVisualEncodingTimeEquation getEncodingTimeEquation()

Specified by:

getEncodingTimeEquation in interface IVisualModule

setEncodingTimeEquation

public void setEncodingTimeEquation(IVisualEncodingTimeEquation equation)

Specified by:

setEncodingTimeEquation in interface IVisualModule

getVisualMemory

public IVisualMemory getVisualMemory()

Description copied from interface: IVisualModule

return the backing short-term iconic memory store

Specified by:

getVisualMemory in interface IVisualModule

Returns:

getPerceptualMemory

public IPerceptualMemory getPerceptualMemory()

Specified by:

getPerceptualMemory in interface IPerceptualMemoryModule

getVisualLocationChunkType

public IChunkType getVisualLocationChunkType()

Specified by:

getVisualLocationChunkType in interface IVisualModule

getVisualChunkType

public IChunkType getVisualChunkType()

Specified by:

getVisualChunkType in interface IVisualModule

assignFINST

public void assignFINST(IChunk visualChunk)

Specified by:

assignFINST in interface IVisualModule

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

Overrides:

setParameter in class AbstractAsynchronousModule

getParameter

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

return parameter value - null if not defined.

Specified by:

getParameter in interface IParameterized

Overrides:

getParameter in class AbstractAsynchronousModule

Parameters:

key - Description of the Parameter

Returns:

The parameter value

getSetableParameters

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

Return list of all parameters that can be set.

Specified by:

getSetableParameters in interface IParameterized

Overrides:

getSetableParameters in class AbstractAsynchronousModule

Returns:

The setableParameters value

applyParameters

protected void applyParameters()

we apply the parameters after the visual map has been created so that we can pass through some parameters

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

Overrides:

initialize in class AbstractPerceptualModule

connectToCommonReality

protected void connectToCommonReality()

Description copied from class: AbstractPerceptualModule

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

Overrides:

connectToCommonReality in class AbstractPerceptualModule

disconnectFromCommonReality

protected void disconnectFromCommonReality()

Description copied from class: AbstractPerceptualModule

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

Overrides:

disconnectFromCommonReality in class AbstractPerceptualModule