org.jactr.modules.pm.visual
Class AbstractVisualModule

java.lang.Object
  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, IInitializable, IInstallable, IParameterized, IPerceptualModule, IVisualModule

Direct Known Subclasses:

DefaultVisualModule6

public abstract class AbstractVisualModule
extends AbstractPerceptualModule
implements IVisualModule, IParameterized

Field Summary

static java.lang.String	ENABLE_BUFFER_STUFF_PARAM
static java.lang.String	ENCODING_TIME_EQUATION_PARAM
static java.lang.String	FINST_DURATION_TIME_PARAM
static java.lang.String	MOVEMENT_TOLERANCE_PARAM
static java.lang.String	NUMBER_OF_FINSTS_PARAM
static java.lang.String	SEARCHING_TIME_EQUATION_PARAM
static java.lang.String	VISUAL_FIELD_HEIGHT_PARAM
static java.lang.String	VISUAL_FIELD_HORIZONTAL_RESOLUTION_PARAM
static java.lang.String	VISUAL_FIELD_VERTICAL_RESOLUTION_PARAM
static java.lang.String	VISUAL_FIELD_WIDTH_PARAM
static java.lang.String	VISUAL_ONSET_DURATION_TIME_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, GREATER_THAN_CURRENT_CHUNK, GUI_CHUNK_TYPE, HEIGHT_SLOT, HIGHEST_CHUNK, KIND_SLOT, LESS_THAN_CURRENT_CHUNK, LINE_CHUNK_TYPE, LOWEST_CHUNK, 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, SEARCH_RESULT_OBJECT_METAKEY, 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.core.module.asynch.IAsynchronousModule

STRICT_SYNCHRONIZATION_PARAM

Constructor Summary

AbstractVisualModule()

Method Summary

void	addListener(IVisualModuleListener listener, java.util.concurrent.Executor executor)
void	assignFINST(IChunk visualChunk)
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.
IVisualSearchTimeEquation	getSearchTimeEquation()
java.util.Collection<java.lang.String>	getSetableParameters() Return list of all parameters that can be set.
IVisicon	getVisicon()
IVisualActivationBuffer	getVisualActivationBuffer()
IChunkType	getVisualChunkType()
IVisualLocationBuffer	getVisualLocationBuffer()
IChunkType	getVisualLocationChunkType()
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)
void	setParameter(java.lang.String key, java.lang.String value) Set the named parameter

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

getBusyChunk, getCommonRealityExecutor, getErrorChunk, getExecutor, getFreeChunk, getRequestedChunk, getUnrequestedChunk

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

getPossibleParameters, isStrictSynchronizationEnabled, setStrictSynchronizationEnabled, synchronizedTimedEvent

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

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

Methods inherited from class java.lang.Object

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

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

encodeVisualChunkAt, reset, scanVisualField, setTrackedVisualChunk

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

getCommonRealityExecutor

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

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

uninstall

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

VISUAL_FIELD_WIDTH_PARAM

public static final java.lang.String VISUAL_FIELD_WIDTH_PARAM

See Also:

Constant Field Values

VISUAL_FIELD_HEIGHT_PARAM

public static final java.lang.String VISUAL_FIELD_HEIGHT_PARAM

See Also:

Constant Field Values

VISUAL_FIELD_HORIZONTAL_RESOLUTION_PARAM

public static final java.lang.String VISUAL_FIELD_HORIZONTAL_RESOLUTION_PARAM

See Also:

Constant Field Values

VISUAL_FIELD_VERTICAL_RESOLUTION_PARAM

public static final java.lang.String VISUAL_FIELD_VERTICAL_RESOLUTION_PARAM

See Also:

Constant Field Values

NUMBER_OF_FINSTS_PARAM

public static final java.lang.String NUMBER_OF_FINSTS_PARAM

See Also:

Constant Field Values

FINST_DURATION_TIME_PARAM

public static final java.lang.String FINST_DURATION_TIME_PARAM

See Also:

Constant Field Values

VISUAL_ONSET_DURATION_TIME_PARAM

public static final java.lang.String VISUAL_ONSET_DURATION_TIME_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

MOVEMENT_TOLERANCE_PARAM

public static final java.lang.String MOVEMENT_TOLERANCE_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

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

getVisualLocationBuffer

public IVisualLocationBuffer getVisualLocationBuffer()

Specified by:

getVisualLocationBuffer in interface IVisualModule

getVisualActivationBuffer

public IVisualActivationBuffer getVisualActivationBuffer()

Specified by:

getVisualActivationBuffer in interface IVisualModule

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

getEncodingTimeEquation

public IVisualEncodingTimeEquation getEncodingTimeEquation()

Specified by:

getEncodingTimeEquation in interface IVisualModule

getVisicon

public IVisicon getVisicon()

Specified by:

getVisicon in interface IVisualModule

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

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