org.jactr.modules.pm.visual.six
Class DefaultVisualModule6

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
                  org.jactr.modules.pm.visual.six.DefaultVisualModule6

All Implemented Interfaces:

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

public class DefaultVisualModule6
extends AbstractVisualModule
implements IVisualModule

Field Summary

static org.apache.commons.logging.Log

LOGGER logger definition

Fields inherited from class org.jactr.modules.pm.visual.AbstractVisualModule

ENABLE_BUFFER_STUFF_PARAM, ENCODING_TIME_EQUATION_PARAM, FINST_DURATION_TIME_PARAM, MOVEMENT_TOLERANCE_PARAM, NUMBER_OF_FINSTS_PARAM, SEARCHING_TIME_EQUATION_PARAM, VISUAL_FIELD_HEIGHT_PARAM, VISUAL_FIELD_HORIZONTAL_RESOLUTION_PARAM, VISUAL_FIELD_VERTICAL_RESOLUTION_PARAM, VISUAL_FIELD_WIDTH_PARAM, 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

DefaultVisualModule6()

Method Summary

void	dispose() release any resources.
java.util.concurrent.Future<IChunk>	encodeVisualChunkAt(ChunkTypeRequest attendPattern, IChunk visualLocation) snag the create the visual chunk at the visual location - actual encoding is taken care of when the chunk is removed from the visual buffer
void	reset() reset the visual system.
java.util.concurrent.Future<IChunk>	scanVisualField(ChunkTypeRequest pattern, boolean isStuffRequest) scan the visual field for a visual-location that matches the passed pattern.
void	setTrackedVisualChunk(IChunk visualChunk) enable the tracking of this chunk.

Methods inherited from class org.jactr.modules.pm.visual.AbstractVisualModule

addListener, assignFINST, dispatch, getCurrentChunk, getEncodingTimeEquation, getGreaterThanCurrentChunk, getHighestChunk, getLessThanCurrentChunk, getLowestChunk, getParameter, getSearchTimeEquation, getSetableParameters, getVisicon, getVisualActivationBuffer, getVisualChunkType, getVisualLocationBuffer, getVisualLocationChunkType, hasListeners, initialize, removeListener, setParameter

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

addListener, assignFINST, dispatch, getEncodingTimeEquation, getSearchTimeEquation, getVisicon, getVisualActivationBuffer, getVisualChunkType, getVisualLocationBuffer, getVisualLocationChunkType, hasListeners, removeListener

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, initialize, install

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

uninstall

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

getPossibleParameters

Field Detail

LOGGER

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

logger definition

Constructor Detail

DefaultVisualModule6

public DefaultVisualModule6()

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 AbstractVisualModule

reset

public void reset()

Description copied from interface: IVisualModule

reset the visual system. this will typically clear both buffers and force the visual chunk encoders to flush their pre-encoded visual chunks. the visual map should remain in tact unless a refresh command is sent to common reality

Specified by:

reset in interface IVisualModule

encodeVisualChunkAt

public java.util.concurrent.Future<IChunk> encodeVisualChunkAt(ChunkTypeRequest attendPattern,
                                                               IChunk visualLocation)

snag the create the visual chunk at the visual location - actual encoding is taken care of when the chunk is removed from the visual buffer

Specified by:

encodeVisualChunkAt in interface IVisualModule

Returns:

See Also:

org.jactr.modules.pm.visual.IVisualModule#encodeVisualChunkAt(org.jactr.core.chunk.IChunk)

scanVisualField

public java.util.concurrent.Future<IChunk> scanVisualField(ChunkTypeRequest pattern,
                                                           boolean isStuffRequest)

Description copied from interface: IVisualModule

scan the visual field for a visual-location that matches the passed pattern. This should do the full range of processing, including handling all the buffer states

If the result is a valid visual location, that chunk must have IVisualModule.SEARCH_RESULT_OBJECT_METAKEY set via IMetaContainer.setMetaData(String, Object) to contain the found visual chunk that will ultimately be returned.

Specified by:

scanVisualField in interface IVisualModule

isStuffRequest - true if this is a buffer stuff attempt

Returns:

error chunk if nothing is found, or visual location chunktype

setTrackedVisualChunk

public void setTrackedVisualChunk(IChunk visualChunk)

enable the tracking of this chunk. if visualChunk is null, it will turn off tracking.

Specified by:

setTrackedVisualChunk in interface IVisualModule

Parameters:

visualChunk - to the visual object or null to turn off

See Also:

IVisualModule.setTrackedVisualChunk(org.jactr.core.chunk.IChunk)