org.jactr.modules.pm.vocal

Class AbstractVocalModule

java.lang.Object

org.jactr.core.utils.DefaultAdaptable

org.jactr.core.module.AbstractModule

org.jactr.core.module.asynch.AbstractAsynchronousModule

org.jactr.modules.pm.AbstractPerceptualModule

org.jactr.modules.pm.vocal.AbstractVocalModule

All Implemented Interfaces:

IAsynchronousModule, IModule, IAdaptable, 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.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

Constructor Summary

Constructors

Constructor and Description
AbstractVocalModule()

Method Summary

Modifier and Type	Method and Description
void	addListener(IVocalModuleListener listener, java.util.concurrent.Executor executor)
protected void	connectToCommonReality() when we connect, we set up listeners for efferent objects and efferent commands
protected java.util.Collection<IActivationBuffer>	createBuffers() called to create any buffers used by this buffer.
protected IVocalActivationBuffer	createVocalBuffer()
protected void	disconnectFromCommonReality() called on model termination to give modules a chance to remove their listeners
void	dispatch(VocalModuleEvent event)
java.util.concurrent.Future<VocalizationCommand>	execute(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()
IEfferentObject	getVocalizationSource()
boolean	hasListeners()
void	initialize() this will be called after all the modules have been installed permitting the module to attach listeners to other modules.
java.util.concurrent.Future<VocalizationCommand>	prepare(IRequest request, double estimatedDuration)
void	removeListener(IVocalModuleListener listener)
void	reset() reset the module
protected void	setExecutionTimeEquation(IVocalExecutionTimeEquation equation)
void	setExecutionTimeResolution(IVocalModule.ExecutionTimeResolution resolution)
protected void	setPreparationTimeEquation(IVocalPreparationTimeEquation equation)
protected void	setProcessingTimeEquation(IVocalProcessingTimeEquation equation)

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

dispose, getBusyChunk, getCommonRealityExecutor, getErrorChunk, getExecutor, getFreeChunk, getNamedChunk, getNamedChunkType, getRequestedChunk, getSymbolGrounder, getUnrequestedChunk, setSymbolGrounder

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, delayedFuture, getModel, getName, getSafeName, immediateFuture, immediateReturn, install, setExecutor, uninstall

Methods inherited from class org.jactr.core.utils.DefaultAdaptable

addAdapterFactory, getAdapter, removeAdapterFactory

Methods inherited from class java.lang.Object

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

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

getCommonRealityExecutor, getSymbolGrounder, setSymbolGrounder

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.IAdaptable

getAdapter

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

getParameter, getPossibleParameters, getSetableParameters, setParameter

Constructor Detail

AbstractVocalModule

public AbstractVocalModule()

Method Detail

setPreparationTimeEquation

protected void setPreparationTimeEquation(IVocalPreparationTimeEquation equation)

setExecutionTimeEquation

protected void setExecutionTimeEquation(IVocalExecutionTimeEquation equation)

setProcessingTimeEquation

protected void setProcessingTimeEquation(IVocalProcessingTimeEquation equation)

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 IModule

Specified by:

reset in interface IVocalModule

createVocalBuffer

protected IVocalActivationBuffer createVocalBuffer()

createBuffers

protected java.util.Collection<IActivationBuffer> createBuffers()

Description copied from class: AbstractModule

called to create any buffers used by this buffer. They will be installed into the model by the install(IModel) call

Overrides:

createBuffers in class AbstractModule

Returns:

connectToCommonReality

protected void connectToCommonReality()

when we connect, we set up listeners for efferent objects and efferent commands

Overrides:

connectToCommonReality in class AbstractPerceptualModule

disconnectFromCommonReality

protected void disconnectFromCommonReality()

Description copied from class: AbstractPerceptualModule

called on model termination to give modules a chance to remove their listeners

Overrides:

disconnectFromCommonReality in class AbstractPerceptualModule

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 IEfferentObject getVocalizationSource()

getExecutionTimeResolution

public IVocalModule.ExecutionTimeResolution getExecutionTimeResolution()

Specified by:

getExecutionTimeResolution in interface IVocalModule

setExecutionTimeResolution

public void setExecutionTimeResolution(IVocalModule.ExecutionTimeResolution resolution)

execute

public java.util.concurrent.Future<VocalizationCommand> execute(VocalizationCommand command)

Specified by:

execute in interface IVocalModule

prepare

public java.util.concurrent.Future<VocalizationCommand> prepare(IRequest request,
                                                                double estimatedDuration)

Specified by:

prepare in interface IVocalModule

addListener

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

Specified by:

addListener in interface IVocalModule

dispatch

public void dispatch(VocalModuleEvent event)

Specified by:

dispatch in interface IVocalModule

hasListeners

public boolean hasListeners()

Specified by:

hasListeners in interface IVocalModule

removeListener

public void removeListener(IVocalModuleListener listener)

Specified by:

removeListener in interface IVocalModule