org.jactr.modules.pm.vocal
Interface IVocalModule

All Superinterfaces:
IAsynchronousModule, IInitializable, IInstallable, IModule, IPerceptualModule
All Known Implementing Classes:
AbstractVocalModule, DefaultVocalModule6

public interface IVocalModule
extends IPerceptualModule


Nested Class Summary
static class IVocalModule.ExecutionTimeResolution
          defines how execution time conflicts are resolved between actr and common reality
 
Field Summary
static java.lang.String CLEAR_CHUNK_TYPE
           
static java.lang.String PREPARATION_EQUATION
           
static java.lang.String SPEAK_CHUNK_TYPE
           
static java.lang.String STRING_SLOT
           
static java.lang.String SUBVOCALIZE_CHUNK_TYPE
           
static java.lang.String VOCAL_BUFFER
           
static java.lang.String VOCALIZATION_EQUATION
           
 
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
 
Method Summary
 void addListener(IVocalModuleListener listener, java.util.concurrent.Executor executor)
           
 void dispatch(VocalModuleEvent event)
           
 java.util.concurrent.Future<org.commonreality.modalities.vocal.VocalizationCommand> execute(org.commonreality.modalities.vocal.VocalizationCommand command)
           
 IVocalExecutionTimeEquation getExecutionTimeEquation()
           
 IVocalModule.ExecutionTimeResolution getExecutionTimeResolution()
           
 IVocalPreparationTimeEquation getPreparationTimeEquation()
           
 java.lang.String getPreparedVocalization()
          returns the currently prepared, but not vocalized speach
 IVocalProcessingTimeEquation getProcessingTimeEquation()
           
 IChunkType getSpeakChunkType()
           
 IChunkType getSubvocalizeChunkType()
           
 IVocalActivationBuffer getVocalBuffer()
           
 boolean hasListeners()
           
 java.util.concurrent.Future<org.commonreality.modalities.vocal.VocalizationCommand> prepare(IRequest request)
           
 void removeListener(IVocalModuleListener listener)
           
 void reset()
          reset the module
 
Methods inherited from interface org.jactr.modules.pm.IPerceptualModule
getCommonRealityExecutor, getSymbolGrounder
 
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

CLEAR_CHUNK_TYPE

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

SPEAK_CHUNK_TYPE

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

SUBVOCALIZE_CHUNK_TYPE

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

STRING_SLOT

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

VOCAL_BUFFER

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

PREPARATION_EQUATION

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

VOCALIZATION_EQUATION

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

getPreparedVocalization

java.lang.String getPreparedVocalization()
returns the currently prepared, but not vocalized speach

Returns:

getExecutionTimeEquation

IVocalExecutionTimeEquation getExecutionTimeEquation()

getPreparationTimeEquation

IVocalPreparationTimeEquation getPreparationTimeEquation()

getProcessingTimeEquation

IVocalProcessingTimeEquation getProcessingTimeEquation()

getSpeakChunkType

IChunkType getSpeakChunkType()

getSubvocalizeChunkType

IChunkType getSubvocalizeChunkType()

getExecutionTimeResolution

IVocalModule.ExecutionTimeResolution getExecutionTimeResolution()

reset

void reset()
reset the module

Specified by:
reset in interface IModule

getVocalBuffer

IVocalActivationBuffer getVocalBuffer()

prepare

java.util.concurrent.Future<org.commonreality.modalities.vocal.VocalizationCommand> prepare(IRequest request)

execute

java.util.concurrent.Future<org.commonreality.modalities.vocal.VocalizationCommand> execute(org.commonreality.modalities.vocal.VocalizationCommand command)

hasListeners

boolean hasListeners()

addListener

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

removeListener

void removeListener(IVocalModuleListener listener)

dispatch

void dispatch(VocalModuleEvent event)