cast.architecture.SubarchitectureWorkingMemory Class Reference

Inheritance diagram for cast.architecture.SubarchitectureWorkingMemory:

List of all members.

Public Member Functions

SubarchitectureWorkingMemory ()

void addReader (WorkingMemoryReaderComponentPrx _reader, Current __current)

void addToWorkingMemory (String _id, String _subarch, String _type, String _component, Ice.Object _entry, Current __current) throws AlreadyExistsOnWMException, UnknownSubarchitectureException

void deleteFromWorkingMemory (String _id, String _subarch, String _component, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException

boolean exists (String _id, String _subarch, Current __current) throws UnknownSubarchitectureException

WorkingMemoryPermissions getPermissions (String _id, String _subarch, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException

int getVersionNumber (String _id, String _subarch, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException

void getWorkingMemoryEntries (String _type, String _subarch, int _count, String _component, WorkingMemoryEntrySeqHolder _entries, Current __current) throws UnknownSubarchitectureException

WorkingMemoryEntry getWorkingMemoryEntry (String _id, String _subarch, String _component, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException

void lockEntry (String _id, String _subarch, String _component, WorkingMemoryPermissions _perm, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException

void overwriteWorkingMemory (String _id, String _subarch, String _type, String _component, Ice.Object _entry, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException

void receiveChangeEvent (WorkingMemoryChange _wmc, Current __current)

void registerComponentFilter (WorkingMemoryChangeFilter _filter, int _priority, Current __current)

void registerWorkingMemoryFilter (WorkingMemoryChangeFilter _filter, String _subarch, int _priority, Current __current)

void removeComponentFilter (WorkingMemoryChangeFilter _filter, Current __current)

void removeWorkingMemoryFilter (WorkingMemoryChangeFilter _filter, Current __current)

void setWorkingMemory (WorkingMemoryPrx _wm, String _subarch, Current __current)

boolean tryLockEntry (String _id, String _subarch, String _component, WorkingMemoryPermissions _perm, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException

void unlockEntry (String _id, String _subarch, String _component, Current __current) throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException

Protected Member Functions

void configureInternal (java.util.Map< String, String > _config)

void addComponentChangeFilter (String _src, WorkingMemoryChangeFilter _data, int _priority)

void addWMChangeFilter (String _src, WorkingMemoryChangeFilter _data, int _priority)

boolean addToWorkingMemory (String _id, WorkingMemoryEntry _data)

void deleteComponentChangeFilter (String _src, WorkingMemoryChangeFilter _data)

void deleteWMChangeFilter (String _src, WorkingMemoryChangeFilter _data)

WorkingMemoryEntry deleteFromWorkingMemory (String _id, String _component) throws DoesNotExistOnWMException

boolean isAllowedChange (WorkingMemoryChange _change)

boolean isSendingXarchChangeNotifications ()

boolean overwriteWorkingMemory (String _id, WorkingMemoryEntry _data, String _component) throws DoesNotExistOnWMException

void printMemoryContents ()

void setSendXarchChangeNotifications (boolean sendXarchChangeNotifications)

boolean isAllowedChange (String _wmID, WorkingMemoryChange _wmc)

Protected Attributes

final CASTWorkingMemoryInterface m_workingMemory

Package Functions

void ignoreChangesFromSubarchitecture (String _subarch)

Detailed Description

Class to act as working memory for a sub-architecture. There are a lot issues about the functionality that this implementation should support. Access to working memory can be achieved by a number of mechanisms
1. Type access. Each entry is given a type string by the originating class with describes the information contained within the entry, e.g. speech string or SIFT feature vector
2. WM Index. Direct random access is available via numerical indices, much like an array. Indices are generated by the working memory itself when new entries are added.
3. Unique ID. Each memory item is given a unique ID by the originating process. This is used so that the originating class has an easy way of referencing data it's created. We will start with string ids for human-readability, but this may change to ints for size.

Author:: nah

Definition at line 70 of file SubarchitectureWorkingMemory.java.

Constructor & Destructor Documentation

cast.architecture.SubarchitectureWorkingMemory.SubarchitectureWorkingMemory ( )

Construct new object with a unique id. Name should be created with createName.

Parameters:

_id

See also:: createID(String)

Definition at line 105 of file SubarchitectureWorkingMemory.java.

Member Function Documentation

void cast.architecture.SubarchitectureWorkingMemory.addComponentChangeFilter	(	String	_src,
		WorkingMemoryChangeFilter	_data,
		int	_priority
	)			`[protected]`

Parameters:

	_src
	_data

Definition at line 172 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.addReader	(	WorkingMemoryReaderComponentPrx	_reader,
		Current	__current
	)

Definition at line 604 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.addToWorkingMemory	(	String	_id,
		String	_subarch,
		String	_type,
		String	_component,
		Ice.Object	_entry,
		Current	__current
	)			throws AlreadyExistsOnWMException, UnknownSubarchitectureException

Definition at line 625 of file SubarchitectureWorkingMemory.java.

boolean cast.architecture.SubarchitectureWorkingMemory.addToWorkingMemory	(	String	_id,
		WorkingMemoryEntry	_data
	)			`[protected]`

Add some data to working memory. If the given id already exists in the working memory then the data isn't added and false is returned.

Parameters:

	_id	The id to use for the data.
	_data	The data itself.

Returns:: True if the data is added successfully, else false.

Definition at line 242 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.addWMChangeFilter	(	String	_src,
		WorkingMemoryChangeFilter	_data,
		int	_priority
	)			`[protected]`

Parameters:

	_src
	_data

Definition at line 192 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.configureInternal ( java.util.Map< String, String > _config ) [protected]

Definition at line 134 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.deleteComponentChangeFilter	(	String	_src,
		WorkingMemoryChangeFilter	_data
	)			`[protected]`

Parameters:

	_src
	_data

Definition at line 254 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.deleteFromWorkingMemory	(	String	_id,
		String	_subarch,
		String	_component,
		Current	__current
	)			throws DoesNotExistOnWMException, UnknownSubarchitectureException

Definition at line 661 of file SubarchitectureWorkingMemory.java.

WorkingMemoryEntry cast.architecture.SubarchitectureWorkingMemory.deleteFromWorkingMemory	(	String	_id,
		String	_component
	)			throws DoesNotExistOnWMException `[protected]`

Delete the specified entry from working memory. If the given id does not exist in the working memory then nothing happens and null is returned.

Parameters:

_id

The id of the entry to delete.

Returns:: The item that is deleted, or null if nothing is deleted.

Exceptions:

DoesNotExistOnWMException

Definition at line 295 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.deleteWMChangeFilter	(	String	_src,
		WorkingMemoryChangeFilter	_data
	)			`[protected]`

Parameters:

	_src
	_data

Definition at line 272 of file SubarchitectureWorkingMemory.java.

boolean cast.architecture.SubarchitectureWorkingMemory.exists	(	String	_id,
		String	_subarch,
		Current	__current
	)			throws UnknownSubarchitectureException

Definition at line 688 of file SubarchitectureWorkingMemory.java.

WorkingMemoryPermissions cast.architecture.SubarchitectureWorkingMemory.getPermissions	(	String	_id,
		String	_subarch,
		Current	__current
	)			throws DoesNotExistOnWMException, UnknownSubarchitectureException

Definition at line 701 of file SubarchitectureWorkingMemory.java.

int cast.architecture.SubarchitectureWorkingMemory.getVersionNumber	(	String	_id,
		String	_subarch,
		Current	__current
	)			throws DoesNotExistOnWMException, UnknownSubarchitectureException

Definition at line 732 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.getWorkingMemoryEntries	(	String	_type,
		String	_subarch,
		int	_count,
		String	_component,
		WorkingMemoryEntrySeqHolder	_entries,
		Current	__current
	)			throws UnknownSubarchitectureException

Definition at line 759 of file SubarchitectureWorkingMemory.java.

WorkingMemoryEntry cast.architecture.SubarchitectureWorkingMemory.getWorkingMemoryEntry	(	String	_id,
		String	_subarch,
		String	_component,
		Current	__current
	)			throws DoesNotExistOnWMException, UnknownSubarchitectureException

Definition at line 793 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.ignoreChangesFromSubarchitecture ( String _subarch ) [package]

Add a subarchitecture which should be ignored for changes

Parameters:

_subarch

Definition at line 598 of file SubarchitectureWorkingMemory.java.

boolean cast.architecture.SubarchitectureWorkingMemory.isAllowedChange	(	String	_wmID,
		WorkingMemoryChange	_wmc
	)			`[protected]`

Determine whether the given change should be sent to the given subarch wm.

Parameters:

	_wmID
	_wmc

Returns:

Definition at line 585 of file SubarchitectureWorkingMemory.java.

boolean cast.architecture.SubarchitectureWorkingMemory.isAllowedChange ( WorkingMemoryChange _change ) [protected]

Determines whether the wm is allowed to forward this change to the attached reader processes.

Parameters:

_change

Returns:: true if the change is not from an ignored sa and passes all the filters

Definition at line 409 of file SubarchitectureWorkingMemory.java.

boolean cast.architecture.SubarchitectureWorkingMemory.isSendingXarchChangeNotifications ( ) [protected]

Determines whether to forward change notifications to other subarchitecture working memories (i.e. its peers).

Returns:: Returns the sendXarchChangeNotifications.

Definition at line 420 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.lockEntry	(	String	_id,
		String	_subarch,
		String	_component,
		WorkingMemoryPermissions	_perm,
		Current	__current
	)			throws DoesNotExistOnWMException, UnknownSubarchitectureException

Definition at line 816 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.overwriteWorkingMemory	(	String	_id,
		String	_subarch,
		String	_type,
		String	_component,
		Ice.Object	_entry,
		Current	__current
	)			throws DoesNotExistOnWMException, UnknownSubarchitectureException

Definition at line 890 of file SubarchitectureWorkingMemory.java.

boolean cast.architecture.SubarchitectureWorkingMemory.overwriteWorkingMemory	(	String	_id,
		WorkingMemoryEntry	_data,
		String	_component
	)			throws DoesNotExistOnWMException `[protected]`

Overwrite some data to working memory. If the given id does not exist in the working memory then the data isn't written and false is returned.

Parameters:

	_id	The id to use for the data.
	_data	The data itself.

Returns:: True if the data is overwritten successfully, else false.

Exceptions:

DoesNotExistOnWMException

Definition at line 435 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.printMemoryContents ( ) [protected]

Print memory contents using component println method.

See also:: println(Object)

Definition at line 475 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.receiveChangeEvent	(	WorkingMemoryChange	_wmc,
		Current	__current
	)

Definition at line 919 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.registerComponentFilter	(	WorkingMemoryChangeFilter	_filter,
		int	_priority,
		Current	__current
	)

Definition at line 942 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.registerWorkingMemoryFilter	(	WorkingMemoryChangeFilter	_filter,
		String	_subarch,
		int	_priority,
		Current	__current
	)

Definition at line 961 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.removeComponentFilter	(	WorkingMemoryChangeFilter	_filter,
		Current	__current
	)

Definition at line 976 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.removeWorkingMemoryFilter	(	WorkingMemoryChangeFilter	_filter,
		Current	__current
	)

Definition at line 995 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.setSendXarchChangeNotifications ( boolean sendXarchChangeNotifications ) [protected]

Determines whether to forward change notifications to other subarchitecture working memories (i.e. its peers).

Parameters:

sendXarchChangeNotifications

The sendXarchChangeNotifications to set.

Definition at line 486 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.setWorkingMemory	(	WorkingMemoryPrx	_wm,
		String	_subarch,
		Current	__current
	)

Definition at line 1009 of file SubarchitectureWorkingMemory.java.

boolean cast.architecture.SubarchitectureWorkingMemory.tryLockEntry	(	String	_id,
		String	_subarch,
		String	_component,
		WorkingMemoryPermissions	_perm,
		Current	__current
	)			throws DoesNotExistOnWMException, UnknownSubarchitectureException

Definition at line 1017 of file SubarchitectureWorkingMemory.java.

void cast.architecture.SubarchitectureWorkingMemory.unlockEntry	(	String	_id,
		String	_subarch,
		String	_component,
		Current	__current
	)			throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException

Definition at line 1051 of file SubarchitectureWorkingMemory.java.

Member Data Documentation

final CASTWorkingMemoryInterface cast.architecture.SubarchitectureWorkingMemory.m_workingMemory [protected]

Definition at line 77 of file SubarchitectureWorkingMemory.java.

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

/Users/nah/Documents/code/cast/src/java/cast/architecture/SubarchitectureWorkingMemory.java


Public Member Functions
	SubarchitectureWorkingMemory ()
void	addReader (WorkingMemoryReaderComponentPrx _reader, Current __current)
void	addToWorkingMemory (String _id, String _subarch, String _type, String _component, Ice.Object _entry, Current __current) throws AlreadyExistsOnWMException, UnknownSubarchitectureException
void	deleteFromWorkingMemory (String _id, String _subarch, String _component, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException
boolean	exists (String _id, String _subarch, Current __current) throws UnknownSubarchitectureException
WorkingMemoryPermissions	getPermissions (String _id, String _subarch, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException
int	getVersionNumber (String _id, String _subarch, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException
void	getWorkingMemoryEntries (String _type, String _subarch, int _count, String _component, WorkingMemoryEntrySeqHolder _entries, Current __current) throws UnknownSubarchitectureException
WorkingMemoryEntry	getWorkingMemoryEntry (String _id, String _subarch, String _component, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException
void	lockEntry (String _id, String _subarch, String _component, WorkingMemoryPermissions _perm, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException
void	overwriteWorkingMemory (String _id, String _subarch, String _type, String _component, Ice.Object _entry, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException
void	receiveChangeEvent (WorkingMemoryChange _wmc, Current __current)
void	registerComponentFilter (WorkingMemoryChangeFilter _filter, int _priority, Current __current)
void	registerWorkingMemoryFilter (WorkingMemoryChangeFilter _filter, String _subarch, int _priority, Current __current)
void	removeComponentFilter (WorkingMemoryChangeFilter _filter, Current __current)
void	removeWorkingMemoryFilter (WorkingMemoryChangeFilter _filter, Current __current)
void	setWorkingMemory (WorkingMemoryPrx _wm, String _subarch, Current __current)
boolean	tryLockEntry (String _id, String _subarch, String _component, WorkingMemoryPermissions _perm, Current __current) throws DoesNotExistOnWMException, UnknownSubarchitectureException
void	unlockEntry (String _id, String _subarch, String _component, Current __current) throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException
Protected Member Functions
void	configureInternal (java.util.Map< String, String > _config)
void	addComponentChangeFilter (String _src, WorkingMemoryChangeFilter _data, int _priority)
void	addWMChangeFilter (String _src, WorkingMemoryChangeFilter _data, int _priority)
boolean	addToWorkingMemory (String _id, WorkingMemoryEntry _data)
void	deleteComponentChangeFilter (String _src, WorkingMemoryChangeFilter _data)
void	deleteWMChangeFilter (String _src, WorkingMemoryChangeFilter _data)
WorkingMemoryEntry	deleteFromWorkingMemory (String _id, String _component) throws DoesNotExistOnWMException
boolean	isAllowedChange (WorkingMemoryChange _change)
boolean	isSendingXarchChangeNotifications ()
boolean	overwriteWorkingMemory (String _id, WorkingMemoryEntry _data, String _component) throws DoesNotExistOnWMException
void	printMemoryContents ()
void	setSendXarchChangeNotifications (boolean sendXarchChangeNotifications)
boolean	isAllowedChange (String _wmID, WorkingMemoryChange _wmc)
Protected Attributes
final CASTWorkingMemoryInterface	m_workingMemory
Package Functions
void	ignoreChangesFromSubarchitecture (String _subarch)