org.jactr.modules.pm.vocal
Class AbstractVocalModule

java.lang.Object
  extended by org.jactr.core.module.AbstractModule
      extended by org.jactr.core.module.asynch.AbstractAsynchronousModule
          extended by org.jactr.modules.pm.AbstractPerceptualModule
              extended by org.jactr.modules.pm.vocal.AbstractVocalModule
All Implemented Interfaces:
IAsynchronousModule, IModule, IInitializable, IInstallable, IParameterized, IPerceptualModule, IVocalModule
Direct Known Subclasses:
DefaultVocalModule6

public class AbstractVocalModule
extends AbstractPerceptualModule
implements IVocalModule

abstract implementation that

Author:
harrison

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.jactr.modules.pm.vocal.IVocalModule
IVocalModule.ExecutionTimeResolution
 
Field Summary
 
Fields inherited from interface org.jactr.modules.pm.vocal.IVocalModule
CLEAR_CHUNK_TYPE, PREPARATION_EQUATION, SPEAK_CHUNK_TYPE, STRING_SLOT, SUBVOCALIZE_CHUNK_TYPE, VOCAL_BUFFER, VOCALIZATION_EQUATION
 
Fields inherited from interface org.jactr.core.module.asynch.IAsynchronousModule
STRICT_SYNCHRONIZATION_PARAM
 
Constructor Summary
AbstractVocalModule()
           
 
Method Summary
 void execute(org.commonreality.identifier.IIdentifier commandId, boolean isVocalization)
           
 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()
           
 org.commonreality.object.IEfferentObject getVocalizationSource()
           
 void initialize()
          this will be called after all the modules have been installed permitting the module to attach listeners to other modules.
 void prepare(ChunkTypeRequest request, java.lang.String text, boolean isVocalization)
          actually prepare the text (controlled by the buffer)
 void reset()
          reset the module
 void setExecutionTimeResolution(IVocalModule.ExecutionTimeResolution resolution)
           
 
Methods inherited from class org.jactr.modules.pm.AbstractPerceptualModule
dispose, getBusyChunk, getCommonRealityExecutor, getErrorChunk, getExecutor, getFreeChunk, getRequestedChunk, getUnrequestedChunk
 
Methods inherited from class org.jactr.core.module.asynch.AbstractAsynchronousModule
getParameter, getPossibleParameters, getSetableParameters, isStrictSynchronizationEnabled, setParameter, 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.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, install
 
Methods inherited from interface org.jactr.core.utils.IInstallable
uninstall
 
Methods inherited from interface org.jactr.core.utils.parameter.IParameterized
getParameter, getPossibleParameters, getSetableParameters, setParameter
 

Constructor Detail

AbstractVocalModule

public AbstractVocalModule()
Method Detail

getPreparedVocalization

public java.lang.String getPreparedVocalization()
Description copied from interface: IVocalModule
returns the currently prepared, but not vocalized speach

Specified by:
getPreparedVocalization in interface IVocalModule
Returns:

getPreparationTimeEquation

public IVocalPreparationTimeEquation getPreparationTimeEquation()
Specified by:
getPreparationTimeEquation in interface IVocalModule

getExecutionTimeEquation

public IVocalExecutionTimeEquation getExecutionTimeEquation()
Specified by:
getExecutionTimeEquation in interface IVocalModule

getProcessingTimeEquation

public IVocalProcessingTimeEquation getProcessingTimeEquation()
Specified by:
getProcessingTimeEquation in interface IVocalModule

getVocalBuffer

public IVocalActivationBuffer getVocalBuffer()
Specified by:
getVocalBuffer in interface IVocalModule

getSpeakChunkType

public IChunkType getSpeakChunkType()
Specified by:
getSpeakChunkType in interface IVocalModule

getSubvocalizeChunkType

public IChunkType getSubvocalizeChunkType()
Specified by:
getSubvocalizeChunkType in interface IVocalModule

reset

public void reset()
Description copied from interface: IVocalModule
reset the module

Specified by:
reset in interface IVocalModule

prepare

public void prepare(ChunkTypeRequest request,
                    java.lang.String text,
                    boolean isVocalization)
actually prepare the text (controlled by the buffer)

Specified by:
prepare in interface IVocalModule
Parameters:
text -

execute

public void execute(org.commonreality.identifier.IIdentifier commandId,
                    boolean isVocalization)
Specified by:
execute in interface IVocalModule

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

getVocalizationSource

public org.commonreality.object.IEfferentObject getVocalizationSource()

getExecutionTimeResolution

public IVocalModule.ExecutionTimeResolution getExecutionTimeResolution()
Specified by:
getExecutionTimeResolution in interface IVocalModule

setExecutionTimeResolution

public void setExecutionTimeResolution(IVocalModule.ExecutionTimeResolution resolution)