cast.core.CASTWorkingMemoryInterface Interface Reference

Inheritance diagram for cast.core.CASTWorkingMemoryInterface:

List of all members.

Public Member Functions
abstract Collection < WorkingMemoryEntry >	getByType (String _type, int _count)
abstract Collection < WorkingMemoryEntry >	getByType (String _type)
abstract boolean	add (String _id, WorkingMemoryEntry _data)
abstract boolean	overwrite (String _id, WorkingMemoryEntry _data)
abstract WorkingMemoryEntry	remove (String _id)
abstract WorkingMemoryEntry	get (String _id)
abstract ArrayList< String >	getIDsByType (String _type, int _count)
abstract int	size ()
abstract boolean	contains (String _queryID)
abstract boolean	hasContained (String _queryID)
abstract int	getOverwriteCount (String _queryID)

---

Detailed Description

An inteface used to define how other objects can access the data items stored in a working memory object. This is for use by objects that actually wrap such an object, not for components that are connected to the working memory in a subarchitecture.

Author:

nah

Definition at line 41 of file CASTWorkingMemoryInterface.java.

---

Member Function Documentation

abstract boolean cast.core.CASTWorkingMemoryInterface.add	(	String	_id,
		WorkingMemoryEntry	_data
	)			[pure virtual]

Adds item to working memory with given id. Does not overwrite data if id already exists.

Parameters:

	_id	The id of the entry.
	_type	The ontological type of the entry.
	_data	The data itself.

Returns:

Returns true if the item is added (i.e. not a duplicate id)

Implemented in cast.core.CASTWorkingMemory.

abstract boolean cast.core.CASTWorkingMemoryInterface.contains

(

String

_queryID

)

[pure virtual]

Whether the wm currently contains an entry with the given id.

Parameters:

_queryID

Returns:

Implemented in cast.core.CASTWorkingMemory.

abstract WorkingMemoryEntry cast.core.CASTWorkingMemoryInterface.get

(

String

_id

)

[pure virtual]

Get the item with the given id.

Parameters:

_id

The specified item or null if it does not exist.

Implemented in cast.core.CASTWorkingMemory.

abstract Collection<WorkingMemoryEntry> cast.core.CASTWorkingMemoryInterface.getByType

(

String

_type

)

[pure virtual]

Get all working memory entries with given type.

Parameters:

_type

The type to check.

Returns:

All matching items from working memory.

Implemented in cast.core.CASTWorkingMemory.

abstract Collection<WorkingMemoryEntry> cast.core.CASTWorkingMemoryInterface.getByType	(	String	_type,
		int	_count
	)			[pure virtual]

Get a collection of memory items with the given ontological type.

Parameters:

	_type	The type to check.
	_count	The number of entries to return. If 0 all matching entries are returned.

Returns:

A collection of matching entries.

Implemented in cast.core.CASTWorkingMemory.

abstract ArrayList<String> cast.core.CASTWorkingMemoryInterface.getIDsByType	(	String	_type,
		int	_count
	)			[pure virtual]

Gets the n most recent ids of entries with the given type.

Parameters:

	_type	The type to check.
	_count	The number of ids to return. If 0 all matching items are return.

Returns:

All matching items.

Implemented in cast.core.CASTWorkingMemory.

abstract int cast.core.CASTWorkingMemoryInterface.getOverwriteCount

(

String

_queryID

)

[pure virtual]

Parameters:

_queryID

Returns:

Implemented in cast.core.CASTWorkingMemory.

abstract boolean cast.core.CASTWorkingMemoryInterface.hasContained

(

String

_queryID

)

[pure virtual]

Whether the wm has ever contained an entry with the given id.

Parameters:

_queryID

Returns:

Implemented in cast.core.CASTWorkingMemory.

abstract boolean cast.core.CASTWorkingMemoryInterface.overwrite	(	String	_id,
		WorkingMemoryEntry	_data
	)			[pure virtual]

Overwrites item with given id. Does not do anything if id does not exist.

Parameters:

	_id	The id of the entry.
	_type	The ontological type of the entry.
	_data	The data itself.

Returns:

Returns true if the id exists for overwriting

Implemented in cast.core.CASTWorkingMemory.

abstract WorkingMemoryEntry cast.core.CASTWorkingMemoryInterface.remove

(

String

_id

)

[pure virtual]

Removes the item with the given id.

Parameters:

_id

The id of the entry.

Returns:

Returns true if the id is removed.

Implemented in cast.core.CASTWorkingMemory.

abstract int cast.core.CASTWorkingMemoryInterface.size

(

)

[pure virtual]

Get the current size of the working memory.

Returns:

The size of working memory.

Implemented in cast.core.CASTWorkingMemory.

---

The documentation for this interface was generated from the following file:

• /Users/nah/Documents/code/cast/src/java/cast/core/CASTWorkingMemoryInterface.java