cast.architecture.WorkingMemoryWriterComponent Class Reference

Inheritance diagram for cast.architecture.WorkingMemoryWriterComponent:

cast.architecture.WorkingMemoryAttachedComponent cast.core.SubarchitectureComponent cast.interfaces._WorkingMemoryAttachedComponentOperations cast.core.CASTComponent cast.interfaces._CASTComponentOperations cast.interfaces._CASTComponentOperations cast.architecture.UnmanagedComponent cast.architecture.WorkingMemoryReaderComponent comedyarch.StraightMan cast.architecture.ManagedComponent cast.architecture.SubarchitectureTaskManager cast.examples.PriorityTest cast.tests.DirectAccessReader cast.tests.DirectAccessWriter comedyarch.AssistantDirector comedyarch.AudienceMember comedyarch.Director comedyarch.FunnyMan cast.architecture.AlwaysPositiveTaskManager

List of all members.

Public Member Functions

 WorkingMemoryWriterComponent ()
void configureInternal (Map< String, String > _config)
void deleteFromWorkingMemory (String _id) throws DoesNotExistOnWMException, PermissionException
void deleteFromWorkingMemory (WorkingMemoryAddress _wma) throws DoesNotExistOnWMException, PermissionException, UnknownSubarchitectureException
void deleteFromWorkingMemory (String _id, String _subarch) throws DoesNotExistOnWMException, PermissionException, UnknownSubarchitectureException
final String newDataID ()
void setWorkingMemory (WorkingMemoryPrx _wm, Current __current)

Protected Member Functions

void startInternal ()
boolean resetWriteCollocationOptimisation ()
void turnOffWriteCollocationOptimisation ()

Protected Attributes

int m_dataCount

Package Functions

public< T extends ObjectImpl > void addToWorkingMemory (String _id, T _data) throws AlreadyExistsOnWMException
public< T extends Object > void addToWorkingMemory (WorkingMemoryAddress _wma, T _data) throws AlreadyExistsOnWMException, DoesNotExistOnWMException, UnknownSubarchitectureException
public< T extends Ice.Object > void addToWorkingMemory (String _id, String _subarch, T _data) throws AlreadyExistsOnWMException, UnknownSubarchitectureException
public< T extends Object > void overwriteWorkingMemory (String _id, T _data) throws DoesNotExistOnWMException, ConsistencyException, PermissionException
public< T extends Object > void overwriteWorkingMemory (WorkingMemoryAddress _wma, T _data) throws DoesNotExistOnWMException, ConsistencyException, PermissionException, UnknownSubarchitectureException
public< T extends Object > void overwriteWorkingMemory (String _id, String _subarch, T _data) throws DoesNotExistOnWMException, PermissionException, ConsistencyException, UnknownSubarchitectureException

Detailed Description

Defines a class of process that can both read from and write to a working memory.

Author:
nah

Definition at line 46 of file WorkingMemoryWriterComponent.java.

Constructor & Destructor Documentation

cast.architecture.WorkingMemoryWriterComponent.WorkingMemoryWriterComponent (  ) 

Parameters:
_id 

Definition at line 68 of file WorkingMemoryWriterComponent.java.

Member Function Documentation

public<T extends Ice.Object> void cast.architecture.WorkingMemoryWriterComponent.addToWorkingMemory ( String  _id,
String  _subarch,
T  _data 
) throws AlreadyExistsOnWMException, UnknownSubarchitectureException [package]

Add new data to working memory. The data will be stored with the given id.

Parameters:
_id The id the data will be stored with.
_subarchitectureID The subarchitecture to write to.
_data The data itself
Exceptions:
AlreadyExistsOnWMException If an entry exists at the given id.
UnknownSubarchitectureException 

Definition at line 155 of file WorkingMemoryWriterComponent.java.

public<T extends Object> void cast.architecture.WorkingMemoryWriterComponent.addToWorkingMemory ( WorkingMemoryAddress  _wma,
T  _data 
) throws AlreadyExistsOnWMException, DoesNotExistOnWMException, UnknownSubarchitectureException [package]

Add new data to working memory. The data will be stored with the given id.

Parameters:
_id The id the data will be stored with.
_data The data itself
Exceptions:
AlreadyExistsOnWMException If an entry exists at the given id.
DoesNotExistOnWMException 
UnknownSubarchitectureException 

Definition at line 134 of file WorkingMemoryWriterComponent.java.

public<T extends ObjectImpl> void cast.architecture.WorkingMemoryWriterComponent.addToWorkingMemory ( String  _id,
T  _data 
) throws AlreadyExistsOnWMException [package]

Add new data to working memory. The data will be stored with the given id.

Parameters:
_id The id the data will be stored with.
_data The data itself
Exceptions:
AlreadyExistsOnWMException If an entry exists at the given id.
DoesNotExistOnWMException 

Definition at line 110 of file WorkingMemoryWriterComponent.java.

void cast.architecture.WorkingMemoryWriterComponent.configureInternal ( Map< String, String >  _config  ) 

Overrides the configure method from FrameworkProcess to use _config to set the subarchitecture ID.

See also:
framework.core.processes.FrameworkProcess.configure(String)
Parameters:
_config The ID of the subarchitecture which contains this component.

Reimplemented from cast.architecture.WorkingMemoryAttachedComponent.

Definition at line 89 of file WorkingMemoryWriterComponent.java.

void cast.architecture.WorkingMemoryWriterComponent.deleteFromWorkingMemory ( String  _id,
String  _subarch 
) throws DoesNotExistOnWMException, PermissionException, UnknownSubarchitectureException

Delete data from working memory with given id.

Parameters:
_id The id of the working memory entry to be deleted.
_subarch The subarchitecture to write to.
_sync Whether to block until the operation completes.
Exceptions:
DoesNotExistOnWMException if the given id does not exist on working memory.
PermissionException 
UnknownSubarchitectureException 

Definition at line 299 of file WorkingMemoryWriterComponent.java.

void cast.architecture.WorkingMemoryWriterComponent.deleteFromWorkingMemory ( WorkingMemoryAddress  _wma  )  throws DoesNotExistOnWMException, PermissionException, UnknownSubarchitectureException

Delete data from working memory with given id.

Parameters:
_id The id of the working memory entry to be deleted.
Exceptions:
PermissionException 
DoesNotExistOnWMException if the given id does not exist on working memory.
UnknownSubarchitectureException 

Definition at line 279 of file WorkingMemoryWriterComponent.java.

void cast.architecture.WorkingMemoryWriterComponent.deleteFromWorkingMemory ( String  _id  )  throws DoesNotExistOnWMException, PermissionException

Delete data from working memory with given id.

Parameters:
_id The id of the working memory entry to be deleted.
Exceptions:
PermissionException 
DoesNotExistOnWMException if the given id does not exist on working memory.

Definition at line 259 of file WorkingMemoryWriterComponent.java.

final String cast.architecture.WorkingMemoryWriterComponent.newDataID (  ) 

Definition at line 365 of file WorkingMemoryWriterComponent.java.

public<T extends Object> void cast.architecture.WorkingMemoryWriterComponent.overwriteWorkingMemory ( String  _id,
String  _subarch,
T  _data 
) throws DoesNotExistOnWMException, PermissionException, ConsistencyException, UnknownSubarchitectureException [package]

Overwrite data in working memory. The data to be overwritten is indicated by the id, which is then used for the id of the new data.

Parameters:
_id The id the data will be stored with
_subarch The subarchitecture to write to.
_data The data itself
Exceptions:
DoesNotExistOnWMException if the given id does not exist to be overwritten.
PermissionException 
ConsistencyException 
UnknownSubarchitectureException 

Definition at line 449 of file WorkingMemoryWriterComponent.java.

public<T extends Object> void cast.architecture.WorkingMemoryWriterComponent.overwriteWorkingMemory ( WorkingMemoryAddress  _wma,
T  _data 
) throws DoesNotExistOnWMException, ConsistencyException, PermissionException, UnknownSubarchitectureException [package]

Overwrite data in working memory. The data to be overwritten is indicated by the id, which is then used for the id of the new data.

Parameters:
_wma The id the data will be stored with
_data The data itself
Exceptions:
DoesNotExistOnWMException if the given id does not exist to be overwritten.
ConsistencyException if this component does not have the most recent version of the data at the given id.
PermissionException 
UnknownSubarchitectureException 

Definition at line 424 of file WorkingMemoryWriterComponent.java.

public<T extends Object> void cast.architecture.WorkingMemoryWriterComponent.overwriteWorkingMemory ( String  _id,
T  _data 
) throws DoesNotExistOnWMException, ConsistencyException, PermissionException [package]

Overwrite data in working memory. The data to be overwritten is indicated by the id, which is then used for the id of the new data.

Parameters:
_id The id the data will be stored with
_data The data itself
Exceptions:
DoesNotExistOnWMException if the given id does not exist to be overwritten.
ConsistencyException if this component does not have the most recent version of the data at the given id.
PermissionException 

Definition at line 395 of file WorkingMemoryWriterComponent.java.

boolean cast.architecture.WorkingMemoryWriterComponent.resetWriteCollocationOptimisation (  )  [protected]

Sets WM proxy for WM writes back to original state. If the original proxy was collocation optimised then writing will now be collocation optimised too (and local changes to written objects will be immediately reflected on WM).

Returns:
true if WM writes will now be collocation optimised.

Definition at line 537 of file WorkingMemoryWriterComponent.java.

void cast.architecture.WorkingMemoryWriterComponent.setWorkingMemory ( WorkingMemoryPrx  _wm,
Current  __current 
)

Overrides setWorkingMemory to create a local copy of the wm pro

Reimplemented from cast.architecture.WorkingMemoryAttachedComponent.

Reimplemented in cast.architecture.WorkingMemoryReaderComponent.

Definition at line 514 of file WorkingMemoryWriterComponent.java.

void cast.architecture.WorkingMemoryWriterComponent.startInternal (  )  [protected]

Reimplemented from cast.core.CASTComponent.

Reimplemented in cast.architecture.WorkingMemoryReaderComponent.

Definition at line 74 of file WorkingMemoryWriterComponent.java.

void cast.architecture.WorkingMemoryWriterComponent.turnOffWriteCollocationOptimisation (  )  [protected]

Sets WM proxy for WM writes to a un-collocation optimised state. Guarantees that local changes to written objects will not appear on WM. This is done automatically on start-up, so users do not need to call it.

Definition at line 548 of file WorkingMemoryWriterComponent.java.

Member Data Documentation

int cast.architecture.WorkingMemoryWriterComponent.m_dataCount [protected]

Definition at line 49 of file WorkingMemoryWriterComponent.java.

The documentation for this class was generated from the following file:
Generated on Mon Jun 13 15:55:46 2011 for CAST Java by  doxygen 1.5.8