org.jactr.modules.pm.common.memory.impl

Class AbstractPerceptualMemory

java.lang.Object

org.jactr.modules.pm.common.memory.impl.AbstractPerceptualMemory

All Implemented Interfaces:

IParameterized, IPerceptualMemory

Direct Known Subclasses:

DefaultAuralMemory, DefaultVisualMemory

public abstract class AbstractPerceptualMemory
extends java.lang.Object
implements IPerceptualMemory

Field Summary

Fields inherited from interface org.jactr.modules.pm.common.memory.IPerceptualMemory

FINST_DURATION_TIME_PARAM, NEW_FINST_ONSET_DURATION_TIME_PARAM, NUMBER_OF_FINSTS_PARAM, SEARCH_RESULT_IDENTIFIER_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractPerceptualMemory(IPerceptualModule module, IIndexManager manager)

Method Summary

Modifier and Type	Method and Description
void	addEncoder(IPerceptualEncoder encoder) add encoder
void	addFeatureMap(IFeatureMap featureMap) attach feature map
void	addFilter(IIndexFilter filter) add post processing search filter
void	addListener(IActivePerceptListener listener, java.util.concurrent.Executor executor)
protected void	addRecentSearch(PerceptualSearchResult result)
void	attach(ACTRAgent agent) attach must be called after the model has been connected to commmon reality
protected java.util.Comparator<ChunkTypeRequest>	createDefaultComparator() create a default comparator when none is specified from the search request or null.
void	detach() detach from CR
protected void	dispatch(ActivePerceptEvent event)
protected void	fillIndexChunk(IChunk indexChunk, IChunk encodedChunk, ChunkTypeRequest originalRequest, ChunkTypeRequest expandedRequest) provides a hook to set the slot values of the returned index chunk in case they are recycled..
protected DefaultAfferentObjectListener	getAfferentObjectListener()
java.util.Collection<IPerceptualEncoder>	getEncoders(java.util.Collection<IPerceptualEncoder> container)
java.util.Collection<IChunk>	getEncodings(IIdentifier identifier, java.util.Collection<IChunk> container) returns all the known encodings of identifier
java.util.Collection<IFeatureMap>	getFeatureMaps(java.util.Collection<IFeatureMap> container) return all the feature maps in the provided container
java.util.Collection<IIndexFilter>	getFilters(java.util.Collection<IIndexFilter> container)
IFINSTFeatureMap	getFINSTFeatureMap() return the finst-able feature map
int	getFINSTLimit()
double	getFINSTSpan()
IIndexManager	getIndexManager()
double	getLastChangeTime() simulation time of the last update
PerceptualSearchResult	getLastSearchResult()
IPerceptualModule	getModule() owning module
protected IChunk	getNamedChunk(java.lang.String name)
double	getNewFINSTOnsetDuration()
protected DelayableAfferentObjectListener	getObjectListener()
java.lang.String	getParameter(java.lang.String key) return parameter value - null if not defined.
int	getPendingUpdates() the number of updates from CR as of yet unprocessed
java.util.Collection<java.lang.String>	getPossibleParameters() Return all parameters that can be read
void	getRecentSearchResults(java.util.List<PerceptualSearchResult> results)
java.util.Collection<java.lang.String>	getSetableParameters() Return list of all parameters that can be set.
protected boolean	hasListeners()
protected boolean	isAcceptable(IChunk encodedChunk, ChunkTypeRequest originalRequest) hook to verify that an encoded chunk should be returned.
boolean	isAttached() have we been attached to CR?
void	removeEncoder(IPerceptualEncoder encoder)
void	removeFeatureMap(IFeatureMap featureMap)
void	removeFilter(IIndexFilter filter)
void	removeListener(IActivePerceptListener listener)
java.util.concurrent.Future<PerceptualSearchResult>	search(ChunkTypeRequest request) search, merely delegates to searchInternal on the common reality executor
protected PerceptualSearchResult	searchInternal(ChunkTypeRequest request)
PerceptualSearchResult	searchNow(ChunkTypeRequest request) search perceptual memory immediately - this should only be called from the CR processing thread
protected PerceptualSearchResult	select(java.util.SortedMap<ChunkTypeRequest,PerceptualSearchResult> results) select the best option.
void	setFINSTLimit(int max)
void	setFINSTSpan(double duration)
void	setNewFINSTOnsetDuration(double duration)
void	setParameter(java.lang.String key, java.lang.String value) Set the named parameter

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPerceptualMemory

public AbstractPerceptualMemory(IPerceptualModule module,
                                IIndexManager manager)

Method Detail

addListener

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

Specified by:

addListener in interface IPerceptualMemory

removeListener

public void removeListener(IActivePerceptListener listener)

Specified by:

removeListener in interface IPerceptualMemory

hasListeners

protected boolean hasListeners()

dispatch

protected void dispatch(ActivePerceptEvent event)

getFINSTLimit

public int getFINSTLimit()

Specified by:

getFINSTLimit in interface IPerceptualMemory

getFINSTSpan

public double getFINSTSpan()

Specified by:

getFINSTSpan in interface IPerceptualMemory

getNewFINSTOnsetDuration

public double getNewFINSTOnsetDuration()

Specified by:

getNewFINSTOnsetDuration in interface IPerceptualMemory

setFINSTLimit

public void setFINSTLimit(int max)

Specified by:

setFINSTLimit in interface IPerceptualMemory

setFINSTSpan

public void setFINSTSpan(double duration)

Specified by:

setFINSTSpan in interface IPerceptualMemory

setNewFINSTOnsetDuration

public void setNewFINSTOnsetDuration(double duration)

Specified by:

setNewFINSTOnsetDuration in interface IPerceptualMemory

getLastChangeTime

public double getLastChangeTime()

Description copied from interface: IPerceptualMemory

simulation time of the last update

Specified by:

getLastChangeTime in interface IPerceptualMemory

Returns:

isAttached

public boolean isAttached()

Description copied from interface: IPerceptualMemory

have we been attached to CR?

Specified by:

isAttached in interface IPerceptualMemory

Returns:

attach

public void attach(ACTRAgent agent)

attach must be called after the model has been connected to commmon reality

Specified by:

attach in interface IPerceptualMemory

Parameters:

agent -

getAfferentObjectListener

protected DefaultAfferentObjectListener getAfferentObjectListener()

detach

public void detach()

Description copied from interface: IPerceptualMemory

detach from CR

Specified by:

detach in interface IPerceptualMemory

getObjectListener

protected DelayableAfferentObjectListener getObjectListener()

getPendingUpdates

public int getPendingUpdates()

Description copied from interface: IPerceptualMemory

the number of updates from CR as of yet unprocessed

Specified by:

getPendingUpdates in interface IPerceptualMemory

Returns:

getModule

public IPerceptualModule getModule()

Description copied from interface: IPerceptualMemory

owning module

Specified by:

getModule in interface IPerceptualMemory

Returns:

addEncoder

public void addEncoder(IPerceptualEncoder encoder)

Description copied from interface: IPerceptualMemory

add encoder

Specified by:

addEncoder in interface IPerceptualMemory

addFeatureMap

public void addFeatureMap(IFeatureMap featureMap)

Description copied from interface: IPerceptualMemory

attach feature map

Specified by:

addFeatureMap in interface IPerceptualMemory

addFilter

public void addFilter(IIndexFilter filter)

Description copied from interface: IPerceptualMemory

add post processing search filter

Specified by:

addFilter in interface IPerceptualMemory

getEncoders

public java.util.Collection<IPerceptualEncoder> getEncoders(java.util.Collection<IPerceptualEncoder> container)

Specified by:

getEncoders in interface IPerceptualMemory

getFINSTFeatureMap

public IFINSTFeatureMap getFINSTFeatureMap()

Description copied from interface: IPerceptualMemory

return the finst-able feature map

Specified by:

getFINSTFeatureMap in interface IPerceptualMemory

Returns:

getFeatureMaps

public java.util.Collection<IFeatureMap> getFeatureMaps(java.util.Collection<IFeatureMap> container)

Description copied from interface: IPerceptualMemory

return all the feature maps in the provided container

Specified by:

getFeatureMaps in interface IPerceptualMemory

Returns:

getFilters

public java.util.Collection<IIndexFilter> getFilters(java.util.Collection<IIndexFilter> container)

Specified by:

getFilters in interface IPerceptualMemory

removeEncoder

public void removeEncoder(IPerceptualEncoder encoder)

Specified by:

removeEncoder in interface IPerceptualMemory

removeFeatureMap

public void removeFeatureMap(IFeatureMap featureMap)

Specified by:

removeFeatureMap in interface IPerceptualMemory

removeFilter

public void removeFilter(IIndexFilter filter)

Specified by:

removeFilter in interface IPerceptualMemory

getEncodings

public java.util.Collection<IChunk> getEncodings(IIdentifier identifier,
                                                 java.util.Collection<IChunk> container)

Description copied from interface: IPerceptualMemory

returns all the known encodings of identifier

Specified by:

getEncodings in interface IPerceptualMemory

Returns:

getIndexManager

public IIndexManager getIndexManager()

Specified by:

getIndexManager in interface IPerceptualMemory

search

public java.util.concurrent.Future<PerceptualSearchResult> search(ChunkTypeRequest request)

search, merely delegates to searchInternal on the common reality executor

Specified by:

search in interface IPerceptualMemory

Parameters:

request -

Returns:

See Also:

IPerceptualMemory.search(org.jactr.core.production.request.ChunkTypeRequest)

searchNow

public PerceptualSearchResult searchNow(ChunkTypeRequest request)

Description copied from interface: IPerceptualMemory

search perceptual memory immediately - this should only be called from the CR processing thread

Specified by:

searchNow in interface IPerceptualMemory

Returns:

createDefaultComparator

protected java.util.Comparator<ChunkTypeRequest> createDefaultComparator()

create a default comparator when none is specified from the search request or null.

Returns:

null

fillIndexChunk

protected void fillIndexChunk(IChunk indexChunk,
                              IChunk encodedChunk,
                              ChunkTypeRequest originalRequest,
                              ChunkTypeRequest expandedRequest)

provides a hook to set the slot values of the returned index chunk in case they are recycled.. default impl does nothing

Parameters:

indexChunk -

encodedChunk -

originalRequest -

expandedRequest -

isAcceptable

protected boolean isAcceptable(IChunk encodedChunk,
                               ChunkTypeRequest originalRequest)

hook to verify that an encoded chunk should be returned. this is the last filter to be called on search results

Parameters:

encodedChunk -

originalRequest -

Returns:

searchInternal

protected PerceptualSearchResult searchInternal(ChunkTypeRequest request)

select

protected PerceptualSearchResult select(java.util.SortedMap<ChunkTypeRequest,PerceptualSearchResult> results)

select the best option. currently just uses the first key (if any)

Parameters:

results -

Returns:

addRecentSearch

protected void addRecentSearch(PerceptualSearchResult result)

getRecentSearchResults

public void getRecentSearchResults(java.util.List<PerceptualSearchResult> results)

Specified by:

getRecentSearchResults in interface IPerceptualMemory

getLastSearchResult

public PerceptualSearchResult getLastSearchResult()

Specified by:

getLastSearchResult in interface IPerceptualMemory

getNamedChunk

protected IChunk getNamedChunk(java.lang.String name)

getParameter

public java.lang.String getParameter(java.lang.String key)

Description copied from interface: IParameterized

return parameter value - null if not defined.

Specified by:

getParameter in interface IParameterized

Parameters:

key - Description of the Parameter

Returns:

The parameter value

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

Description copied from interface: IParameterized

Set the named parameter

Specified by:

setParameter in interface IParameterized

getSetableParameters

public java.util.Collection<java.lang.String> getSetableParameters()

Description copied from interface: IParameterized

Return list of all parameters that can be set.

Specified by:

getSetableParameters in interface IParameterized

Returns:

The setableParameters value

getPossibleParameters

public java.util.Collection<java.lang.String> getPossibleParameters()

Description copied from interface: IParameterized

Return all parameters that can be read

Specified by:

getPossibleParameters in interface IParameterized

Returns:

The possibleParameters value