org.jactr.modules.pm.common.buffer

Class AbstractCapacityPMActivationBuffer6

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.six.AbstractCapacityBuffer6

org.jactr.modules.pm.common.buffer.AbstractCapacityPMActivationBuffer6

All Implemented Interfaces:

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

public abstract class AbstractCapacityPMActivationBuffer6
extends AbstractCapacityBuffer6
implements IDelegatedRequestableBuffer, IPerceptualBuffer, IEventTrackingActivationBuffer, ICompilableBuffer

Author:

developer

Nested Class Summary

Nested classes/interfaces inherited from interface org.jactr.core.buffer.ICapacityBuffer

ICapacityBuffer.EjectionPolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Collection<IRequestDelegate>	_chunkPatternProcessors
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.six.AbstractCapacityBuffer6

_ejectionPolicy

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

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

EJECTION_POLICY_PARAM

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addRequestDelegate(IRequestDelegate processor)
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()
java.util.Collection<IRequestDelegate>	getRequestDelegates() returns the actual backing collection
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
void	removeRequestDelegate(IRequestDelegate processor)
protected boolean	requestInternal(IRequest request, double requestTime) actually do the work of the request.
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.six.AbstractCapacityBuffer6

addSourceChunkInternal, chunkInserted, chunkRemoved, getChunksAndTimes, getEjectionPolicy, getParameter, getPossibleParameters, getSetableParameters, getSourceChunkInternal, getSourceChunksInternal, getTimesAndChunks, isCapacityReached, matchedInternal, removeSourceChunkInternal, setEjectionPolicy, setParameter

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, getSourceChunk, getSourceChunks, getSourceChunks, handlesEncoding, isStrictHarvestingEnabled, matched, removeListener, removeSourceChunk, setActivation, setActivationSpreader, setG, 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.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

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

getSourceChunks

Field Detail

_chunkPatternProcessors

protected java.util.Collection<IRequestDelegate> _chunkPatternProcessors

_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

AbstractCapacityPMActivationBuffer6

public AbstractCapacityPMActivationBuffer6(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 AbstractCapacityBuffer6

initialize

public void initialize()

Description copied from interface: IInitializable

intialize this component

Specified by:

initialize in interface IInitializable

Overrides:

initialize in class AbstractCapacityBuffer6

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

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:

clearInternal

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

clear the buffer and abort any timed events that are pending

Overrides:

clearInternal in class AbstractActivationBuffer6

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

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

Specified by:

isValidChunkType in class AbstractCapacityBuffer6

Parameters:

chunkType -

Returns:

addRequestDelegate

public void addRequestDelegate(IRequestDelegate processor)

Specified by:

addRequestDelegate in interface IDelegatedRequestableBuffer

removeRequestDelegate

public void removeRequestDelegate(IRequestDelegate processor)

Specified by:

removeRequestDelegate in interface IDelegatedRequestableBuffer

getRequestDelegates

public java.util.Collection<IRequestDelegate> getRequestDelegates()

returns the actual backing collection

Specified by:

getRequestDelegates in interface IDelegatedRequestableBuffer

Returns:

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

Returns:

requestInternal

protected boolean requestInternal(IRequest request,
                                  double requestTime)
                           throws java.lang.IllegalArgumentException

Description copied from class: AbstractRequestableBuffer6

actually do the work of the request. this is called within the write lock

Specified by:

requestInternal in class AbstractRequestableBuffer6

Returns:

Throws:

java.lang.IllegalArgumentException

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