org.jactr.modules.pm.visual
Interface IVisualModule

All Superinterfaces:
IAsynchronousModule, IInitializable, IInstallable, IModule, IPerceptualModule
All Known Implementing Classes:
AbstractVisualModule, DefaultVisualModule6

public interface IVisualModule
extends IPerceptualModule


Field Summary
static java.lang.String ASSIGN_FINST_CHUNK_TYPE
           
static java.lang.String ATTENDED_STATUS_SLOT
           
static java.lang.String CLEAR_CHUNK_TYPE
           
static java.lang.String COLOR_CHUNK_TYPE
           
static java.lang.String COLOR_SLOT
          Comment for COLOR
static java.lang.String CURRENT_CHUNK
           
static java.lang.String CURSOR_CHUNK_TYPE
           
static java.lang.String EMPTY_CHUNK_TYPE
           
static java.lang.String GREATER_THAN_CURRENT_CHUNK
           
static java.lang.String GUI_CHUNK_TYPE
           
static java.lang.String HEIGHT_SLOT
          Comment for HEIGHT
static java.lang.String HIGHEST_CHUNK
           
static java.lang.String KIND_SLOT
          Comment for KIND
static java.lang.String LESS_THAN_CURRENT_CHUNK
           
static java.lang.String LINE_CHUNK_TYPE
           
static java.lang.String LOWEST_CHUNK
           
static java.lang.String MOVE_ATTENTION_CHUNK_TYPE
           
static java.lang.String NEAREST_SLOT
          Comment for NEAREST
static java.lang.String OBJECTS_SLOT
          Deprecated. 
static java.lang.String OVAL_CHUNK_TYPE
           
static java.lang.String PHRASE_CHUNK_TYPE
           
static java.lang.String SCREEN_POSITION_SLOT
          Comment for SCREEN_POSITION
static java.lang.String SCREEN_X_SLOT
          Comment for SCREEN_X_SLOT
static java.lang.String SCREEN_Y_SLOT
          Comment for SCREEN_Y
static java.lang.String SCREEN_Z_SLOT
          Comment for SCREEN_Z
static java.lang.String SEARCH_RESULT_OBJECT_METAKEY
          meta data key for the returned visual location after #scanVisualField(ChunkPattern, boolean) returns.
static java.lang.String SIZE_SLOT
          Comment for SIZE
static java.lang.String START_TRACKING_CHUNK_TYPE
           
static java.lang.String TEXT_CHUNK_TYPE
           
static java.lang.String TIME_STATUS_SLOT
           
static java.lang.String TOKEN_SLOT
          Comment for TOKEN
static java.lang.String TYPE_SLOT
          Comment for TYPE
static java.lang.String VALUE_SLOT
          Comment for VALUE
static java.lang.String VISUAL_BUFFER
           
static java.lang.String VISUAL_CHUNK_TYPE
           
static java.lang.String VISUAL_COMMAND_CHUNK_TYPE
           
static java.lang.String VISUAL_LOCATION_BUFFER
          buffer names
static java.lang.String VISUAL_LOCATION_CHUNK_TYPE
          chunk type names
static java.lang.String WIDTH_SLOT
          Comment for WIDTH
 
Fields inherited from interface org.jactr.core.module.asynch.IAsynchronousModule
STRICT_SYNCHRONIZATION_PARAM
 
Method Summary
 void addListener(IVisualModuleListener listener, java.util.concurrent.Executor executor)
           
 void assignFINST(IChunk visualChunk)
           
 void dispatch(VisualModuleEvent event)
           
 java.util.concurrent.Future<IChunk> encodeVisualChunkAt(ChunkTypeRequest attendingPattern, IChunk visualLocation)
          return a visual object that is location at visual location the visual buffer itself while handle the encoding into the model, this merely returns the representation of the chunk at the location this must have been preceeded by a scanVisualField call, otherwise the objects slot in the visualLocation will not be correct
 IVisualEncodingTimeEquation getEncodingTimeEquation()
           
 IVisualSearchTimeEquation getSearchTimeEquation()
           
 IVisicon getVisicon()
           
 IVisualActivationBuffer getVisualActivationBuffer()
           
 IChunkType getVisualChunkType()
           
 IVisualLocationBuffer getVisualLocationBuffer()
           
 IChunkType getVisualLocationChunkType()
           
 boolean hasListeners()
           
 void removeListener(IVisualModuleListener listener)
           
 void reset()
          reset the visual system.
 java.util.concurrent.Future<IChunk> scanVisualField(ChunkTypeRequest chunkPattern, boolean isStuffRequest)
          scan the visual field for a visual-location that matches the passed pattern.
 void setTrackedVisualChunk(IChunk visualChunk)
          engage the visual tracking mechanism..
 
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
dispose, getModel, getName, initialize, install
 
Methods inherited from interface org.jactr.core.utils.IInstallable
uninstall
 

Field Detail

SEARCH_RESULT_OBJECT_METAKEY

static final java.lang.String SEARCH_RESULT_OBJECT_METAKEY
meta data key for the returned visual location after #scanVisualField(ChunkPattern, boolean) returns. If the returned chunk is a visual location, its meta data for this key must contain the visual chunk found.


VISUAL_LOCATION_BUFFER

static final java.lang.String VISUAL_LOCATION_BUFFER
buffer names

See Also:
Constant Field Values

VISUAL_BUFFER

static final java.lang.String VISUAL_BUFFER
See Also:
Constant Field Values

VISUAL_LOCATION_CHUNK_TYPE

static final java.lang.String VISUAL_LOCATION_CHUNK_TYPE
chunk type names

See Also:
Constant Field Values

VISUAL_CHUNK_TYPE

static final java.lang.String VISUAL_CHUNK_TYPE
See Also:
Constant Field Values

VISUAL_COMMAND_CHUNK_TYPE

static final java.lang.String VISUAL_COMMAND_CHUNK_TYPE
See Also:
Constant Field Values

CLEAR_CHUNK_TYPE

static final java.lang.String CLEAR_CHUNK_TYPE
See Also:
Constant Field Values

MOVE_ATTENTION_CHUNK_TYPE

static final java.lang.String MOVE_ATTENTION_CHUNK_TYPE
See Also:
Constant Field Values

ASSIGN_FINST_CHUNK_TYPE

static final java.lang.String ASSIGN_FINST_CHUNK_TYPE
See Also:
Constant Field Values

START_TRACKING_CHUNK_TYPE

static final java.lang.String START_TRACKING_CHUNK_TYPE
See Also:
Constant Field Values

COLOR_CHUNK_TYPE

static final java.lang.String COLOR_CHUNK_TYPE
See Also:
Constant Field Values

TEXT_CHUNK_TYPE

static final java.lang.String TEXT_CHUNK_TYPE
See Also:
Constant Field Values

PHRASE_CHUNK_TYPE

static final java.lang.String PHRASE_CHUNK_TYPE
See Also:
Constant Field Values

OVAL_CHUNK_TYPE

static final java.lang.String OVAL_CHUNK_TYPE
See Also:
Constant Field Values

GUI_CHUNK_TYPE

static final java.lang.String GUI_CHUNK_TYPE
See Also:
Constant Field Values

CURSOR_CHUNK_TYPE

static final java.lang.String CURSOR_CHUNK_TYPE
See Also:
Constant Field Values

EMPTY_CHUNK_TYPE

static final java.lang.String EMPTY_CHUNK_TYPE
See Also:
Constant Field Values

LINE_CHUNK_TYPE

static final java.lang.String LINE_CHUNK_TYPE
See Also:
Constant Field Values

SCREEN_X_SLOT

static final java.lang.String SCREEN_X_SLOT
Comment for SCREEN_X_SLOT

See Also:
Constant Field Values

SCREEN_Y_SLOT

static final java.lang.String SCREEN_Y_SLOT
Comment for SCREEN_Y

See Also:
Constant Field Values

SCREEN_Z_SLOT

static final java.lang.String SCREEN_Z_SLOT
Comment for SCREEN_Z

See Also:
Constant Field Values

KIND_SLOT

static final java.lang.String KIND_SLOT
Comment for KIND

See Also:
Constant Field Values

COLOR_SLOT

static final java.lang.String COLOR_SLOT
Comment for COLOR

See Also:
Constant Field Values

SIZE_SLOT

static final java.lang.String SIZE_SLOT
Comment for SIZE

See Also:
Constant Field Values

NEAREST_SLOT

static final java.lang.String NEAREST_SLOT
Comment for NEAREST

See Also:
Constant Field Values

OBJECTS_SLOT

@Deprecated
static final java.lang.String OBJECTS_SLOT
Deprecated. 
Comment for OBJECTS deprecated, the objects slot has been removed

See Also:
Constant Field Values

SCREEN_POSITION_SLOT

static final java.lang.String SCREEN_POSITION_SLOT
Comment for SCREEN_POSITION

See Also:
Constant Field Values

VALUE_SLOT

static final java.lang.String VALUE_SLOT
Comment for VALUE

See Also:
Constant Field Values

WIDTH_SLOT

static final java.lang.String WIDTH_SLOT
Comment for WIDTH

See Also:
Constant Field Values

TYPE_SLOT

static final java.lang.String TYPE_SLOT
Comment for TYPE

See Also:
Constant Field Values

TOKEN_SLOT

static final java.lang.String TOKEN_SLOT
Comment for TOKEN

See Also:
Constant Field Values

HEIGHT_SLOT

static final java.lang.String HEIGHT_SLOT
Comment for HEIGHT

See Also:
Constant Field Values

ATTENDED_STATUS_SLOT

static final java.lang.String ATTENDED_STATUS_SLOT
See Also:
Constant Field Values

TIME_STATUS_SLOT

static final java.lang.String TIME_STATUS_SLOT
See Also:
Constant Field Values

CURRENT_CHUNK

static final java.lang.String CURRENT_CHUNK
See Also:
Constant Field Values

HIGHEST_CHUNK

static final java.lang.String HIGHEST_CHUNK
See Also:
Constant Field Values

LOWEST_CHUNK

static final java.lang.String LOWEST_CHUNK
See Also:
Constant Field Values

LESS_THAN_CURRENT_CHUNK

static final java.lang.String LESS_THAN_CURRENT_CHUNK
See Also:
Constant Field Values

GREATER_THAN_CURRENT_CHUNK

static final java.lang.String GREATER_THAN_CURRENT_CHUNK
See Also:
Constant Field Values
Method Detail

addListener

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

removeListener

void removeListener(IVisualModuleListener listener)

hasListeners

boolean hasListeners()

dispatch

void dispatch(VisualModuleEvent event)

getVisualLocationBuffer

IVisualLocationBuffer getVisualLocationBuffer()

getVisualActivationBuffer

IVisualActivationBuffer getVisualActivationBuffer()

getSearchTimeEquation

IVisualSearchTimeEquation getSearchTimeEquation()

getEncodingTimeEquation

IVisualEncodingTimeEquation getEncodingTimeEquation()

getVisualLocationChunkType

IChunkType getVisualLocationChunkType()

getVisualChunkType

IChunkType getVisualChunkType()

getVisicon

IVisicon getVisicon()

scanVisualField

java.util.concurrent.Future<IChunk> scanVisualField(ChunkTypeRequest chunkPattern,
                                                    boolean isStuffRequest)
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 SEARCH_RESULT_OBJECT_METAKEY set via IMetaContainer.setMetaData(String, Object) to contain the found visual chunk that will ultimately be returned.

Parameters:
chunkPattern -
isStuffRequest - true if this is a buffer stuff attempt
Returns:
error chunk if nothing is found, or visual location chunktype

encodeVisualChunkAt

java.util.concurrent.Future<IChunk> encodeVisualChunkAt(ChunkTypeRequest attendingPattern,
                                                        IChunk visualLocation)
return a visual object that is location at visual location the visual buffer itself while handle the encoding into the model, this merely returns the representation of the chunk at the location this must have been preceeded by a scanVisualField call, otherwise the objects slot in the visualLocation will not be correct

Parameters:
visualLocation -
Returns:

setTrackedVisualChunk

void setTrackedVisualChunk(IChunk visualChunk)
engage the visual tracking mechanism..

Parameters:
visualChunk - to the visual object or null to turn off

reset

void reset()
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


assignFINST

void assignFINST(IChunk visualChunk)