org.jactr.modules.pm.common.buffer

Class AbstractPMActivationBuffer6

java.lang.Object

org.jactr.core.utils.DefaultAdaptable

org.jactr.core.buffer.AbstractActivationBuffer

org.jactr.core.buffer.six.AbstractActivationBuffer6

org.jactr.core.buffer.six.AbstractRequestableBuffer6

org.jactr.core.buffer.delegate.DefaultDelegatedRequestableBuffer6

org.jactr.modules.pm.common.buffer.AbstractPMActivationBuffer6

All Implemented Interfaces:

IDelegatedRequestableBuffer, IActivationBuffer, IRequestableBuffer, IStatusBuffer, ICompilableBuffer, INotifyingSlotContainer, ISlotContainer, IUniqueSlotContainer, IAdaptable, IInitializable, IParameterized, IEventTrackingActivationBuffer, IPerceptualBuffer

Direct Known Subclasses:

DefaultAuralActivationBuffer, DefaultAuralLocationBuffer, DefaultMotorActivationBuffer6, DefaultVisualActivationBuffer6, DefaultVisualLocationBuffer6, DefaultVocalActivationBuffer6

public abstract class AbstractPMActivationBuffer6
extends DefaultDelegatedRequestableBuffer6
implements IDelegatedRequestableBuffer, IPerceptualBuffer, IEventTrackingActivationBuffer, ICompilableBuffer

Author:

developer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Collection<ITimedEvent>	_pendingTimedEvents we track all timed events used for this buffer so that if a clear comes in, we can abort

Fields inherited from class org.jactr.core.buffer.AbstractActivationBuffer

ACTIVATION_PARAM, GOAL_VALUE_PARAM, STRICT_HARVESTING_PARAM

Fields inherited from interface org.jactr.modules.pm.buffer.IPerceptualBuffer

EXECUTION_SLOT, IS_BUFFER_STUFF_REQUEST, MODALITY_SLOT, PREPARATION_SLOT, PROCESSOR_SLOT

Fields inherited from interface org.jactr.core.buffer.six.IStatusBuffer

BUFFER_SLOT, ERROR_CHANGED_TOO_MUCH_CHUNK, ERROR_DELETED_CHUNK, ERROR_INVALID_INDEX_CHUNK, ERROR_NO_LONGER_AVAILABLE_CHUNK, ERROR_NOTHING_AVAILABLE_CHUNK, ERROR_NOTHING_MATCHES_CHUNK, ERROR_SLOT, ERROR_UNKNOWN_CHUNK, STATE_SLOT

Fields inherited from interface org.jactr.core.buffer.IActivationBuffer

AURAL, AURAL_LOCATION, GOAL, IMAGINAL, MOTOR, RETRIEVAL, VISUAL, VISUAL_LOCATION, VOCAL

Constructor Summary

Constructors

Constructor and Description
AbstractPMActivationBuffer6(java.lang.String name, IModule module)

Method Summary

Modifier and Type	Method and Description
protected IChunk	addSourceChunkInternal(IChunk chunkToInsert) return the source chunk that was actually inserted into the buffer (i.e.
void	clear() will call removeSourceChunkInternal for all the chunks and then recalculate activation
protected java.util.Collection<IChunk>	clearInternal() clear the buffer and abort any timed events that are pending
void	dispose() clean up resources, called by the module that created the buffer
void	enqueueTimedEvent(ITimedEvent timedEvent) called when we want to queue a timed event onto the model's event queue this also tracks all the pending events so that if they fire or get aborted we are notified, and it permits us to abort when a clear is called
ICompilableContext	getCompilableContext()
protected void	grabReferences() called once the model is started.
void	initialize() intialize this component
boolean	isExecutionBusy()
boolean	isExecutionFree()
boolean	isModalityBusy()
boolean	isModalityFree()
boolean	isPreparationBusy()
boolean	isPreparationFree()
boolean	isProcessorBusy()
boolean	isProcessorFree()
protected abstract boolean	isValidChunkType(IChunkType chunkType) check to see if a chunk of this chunktype can be added as a source chunk
protected boolean	removeSourceChunkInternal(IChunk chunkToRemove) do the actual work of removing chunkToRemove from the buffer.
void	setExecutionChunk(IChunk chunk)
void	setModalityChunk(IChunk chunk)
void	setPreparationChunk(IChunk chunk)
void	setProcessorChunk(IChunk chunk)
protected boolean	shouldCopyOnInsertion(IChunk chunk) the super type uses a more specific test, but since we know perceptual buffers are only going to be continaing the sanctioned perceptual chunks, we don't need to do all the buffer containment tests and just the encoding test should suffice.
boolean	willAccept(IRequest request) return true if this buffer would accept this request

Methods inherited from class org.jactr.core.buffer.delegate.DefaultDelegatedRequestableBuffer6

addRequestDelegate, getRequestDelegates, getSourceChunkInternal, getSourceChunksInternal, removeRequestDelegate, requestInternal, setSourceChunkInternal

Methods inherited from class org.jactr.core.buffer.six.AbstractRequestableBuffer6

request

Methods inherited from class org.jactr.core.buffer.six.AbstractActivationBuffer6

addListener, addSlot, addSourceChunk, bind, checkStatusSlotContent, getBusyChunk, getEmptyChunk, getErrorChunk, getFreeChunk, getFullChunk, getRequestedChunk, getSlot, getSlots, getSlots, getUnrequestedChunk, hasSlot, isBufferEmpty, isBufferFull, isBufferRequested, isBufferUnrequested, isErrorSet, isStateBusy, isStateError, isStateFree, removeListener, removeSlot, setBufferChunk, setErrorChunk, setStateChunk, setStatusSlotContent, shouldAcceptAsSource, sourceChunkCopied, valueChanged

Methods inherited from class org.jactr.core.buffer.AbstractActivationBuffer

addListener, contains, containsExact, getActivation, getActivationSpreader, getEventDispatcher, getG, getLock, getModel, getModule, getName, getParameter, getPossibleParameters, getSetableParameters, getSourceChunk, getSourceChunks, getSourceChunks, handlesEncoding, isStrictHarvestingEnabled, matched, matchedInternal, removeListener, removeSourceChunk, setActivation, setActivationSpreader, setG, setParameter, setStrictHarvestingEnabled, toString

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, wait, wait, wait

Methods inherited from interface org.jactr.core.buffer.six.IStatusBuffer

bind, isBufferEmpty, isBufferFull, isBufferRequested, isBufferUnrequested, isErrorSet, isStateBusy, isStateError, isStateFree, setBufferChunk, setErrorChunk, setStateChunk

Methods inherited from interface org.jactr.core.slot.INotifyingSlotContainer

addListener, removeListener, valueChanged

Methods inherited from interface org.jactr.core.slot.IUniqueSlotContainer

getSlot, hasSlot

Methods inherited from interface org.jactr.core.slot.ISlotContainer

addSlot, getSlots, getSlots, removeSlot

Methods inherited from interface org.jactr.core.buffer.delegate.IDelegatedRequestableBuffer

addRequestDelegate, getRequestDelegates, removeRequestDelegate

Methods inherited from interface org.jactr.core.buffer.IRequestableBuffer

request

Methods inherited from interface org.jactr.core.buffer.IActivationBuffer

addListener, addSourceChunk, contains, getActivation, getG, getModel, getModule, getName, getSourceChunk, getSourceChunks, getSourceChunks, handlesEncoding, isStrictHarvestingEnabled, matched, removeListener, removeSourceChunk, setActivation, setG

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

getAdapter

Field Detail

_pendingTimedEvents

protected java.util.Collection<ITimedEvent> _pendingTimedEvents

we track all timed events used for this buffer so that if a clear comes in, we can abort

Constructor Detail

AbstractPMActivationBuffer6

public AbstractPMActivationBuffer6(java.lang.String name,
                                   IModule module)

Method Detail

dispose

public void dispose()

Description copied from interface: IActivationBuffer

clean up resources, called by the module that created the buffer

Specified by:

dispose in interface IActivationBuffer

Overrides:

dispose in class AbstractActivationBuffer6

initialize

public void initialize()

Description copied from interface: IInitializable

intialize this component

Specified by:

initialize in interface IInitializable

Overrides:

initialize in class AbstractActivationBuffer

grabReferences

protected void grabReferences()

Description copied from class: AbstractActivationBuffer

called once the model is started. this is the hook to grab references to chunks & types

Overrides:

grabReferences in class AbstractActivationBuffer6

clearInternal

protected java.util.Collection<IChunk> clearInternal()

clear the buffer and abort any timed events that are pending

Overrides:

clearInternal in class DefaultDelegatedRequestableBuffer6

Returns:

the chunks that were removed

See Also:

AbstractActivationBuffer.clear()

clear

public void clear()

Description copied from class: AbstractActivationBuffer

will call removeSourceChunkInternal for all the chunks and then recalculate activation

Specified by:

clear in interface IActivationBuffer

Overrides:

clear in class AbstractActivationBuffer

See Also:

IActivationBuffer.clear()

shouldCopyOnInsertion

protected boolean shouldCopyOnInsertion(IChunk chunk)

the super type uses a more specific test, but since we know perceptual buffers are only going to be continaing the sanctioned perceptual chunks, we don't need to do all the buffer containment tests and just the encoding test should suffice.

Overrides:

shouldCopyOnInsertion in class AbstractActivationBuffer6

Returns:

enqueueTimedEvent

public void enqueueTimedEvent(ITimedEvent timedEvent)

called when we want to queue a timed event onto the model's event queue this also tracks all the pending events so that if they fire or get aborted we are notified, and it permits us to abort when a clear is called

Specified by:

enqueueTimedEvent in interface IEventTrackingActivationBuffer

Parameters:

timedEvent -

isValidChunkType

protected abstract boolean isValidChunkType(IChunkType chunkType)

check to see if a chunk of this chunktype can be added as a source chunk

Parameters:

chunkType -

Returns:

addSourceChunkInternal

protected IChunk addSourceChunkInternal(IChunk chunkToInsert)

Description copied from class: AbstractActivationBuffer

return the source chunk that was actually inserted into the buffer (i.e. a copy of chunkToInsert if chunkToInsert has already been encoded).

Overrides:

addSourceChunkInternal in class DefaultDelegatedRequestableBuffer6

Parameters:

chunkToInsert - the chunk to be inserted, will never be null nor already in the buffer

Returns:

actual chunk inserted. if null, no events are fired or activation spread

removeSourceChunkInternal

protected boolean removeSourceChunkInternal(IChunk chunkToRemove)

Description copied from class: AbstractActivationBuffer

do the actual work of removing chunkToRemove from the buffer.

Overrides:

removeSourceChunkInternal in class DefaultDelegatedRequestableBuffer6

Parameters:

chunkToRemove - chunk that is in the buffer, never null

Returns:

true if activation is to be reset and an event fired

See Also:

AbstractActivationBuffer.removeSourceChunkInternal(org.jactr.core.chunk.IChunk)

willAccept

public boolean willAccept(IRequest request)

Description copied from interface: IRequestableBuffer

return true if this buffer would accept this request

Specified by:

willAccept in interface IRequestableBuffer

Overrides:

willAccept in class DefaultDelegatedRequestableBuffer6

Returns:

isModalityFree

public boolean isModalityFree()

Specified by:

isModalityFree in interface IPerceptualBuffer

isProcessorFree

public boolean isProcessorFree()

Specified by:

isProcessorFree in interface IPerceptualBuffer

isPreparationFree

public boolean isPreparationFree()

Specified by:

isPreparationFree in interface IPerceptualBuffer

isExecutionFree

public boolean isExecutionFree()

Specified by:

isExecutionFree in interface IPerceptualBuffer

isModalityBusy

public boolean isModalityBusy()

Specified by:

isModalityBusy in interface IPerceptualBuffer

isProcessorBusy

public boolean isProcessorBusy()

Specified by:

isProcessorBusy in interface IPerceptualBuffer

isPreparationBusy

public boolean isPreparationBusy()

Specified by:

isPreparationBusy in interface IPerceptualBuffer

isExecutionBusy

public boolean isExecutionBusy()

Specified by:

isExecutionBusy in interface IPerceptualBuffer

setModalityChunk

public void setModalityChunk(IChunk chunk)

Specified by:

setModalityChunk in interface IPerceptualBuffer

setExecutionChunk

public void setExecutionChunk(IChunk chunk)

Specified by:

setExecutionChunk in interface IPerceptualBuffer

setPreparationChunk

public void setPreparationChunk(IChunk chunk)

Specified by:

setPreparationChunk in interface IPerceptualBuffer

setProcessorChunk

public void setProcessorChunk(IChunk chunk)

Specified by:

setProcessorChunk in interface IPerceptualBuffer

getCompilableContext

public ICompilableContext getCompilableContext()

Specified by:

getCompilableContext in interface ICompilableBuffer