
Public Member Functions | |
| void | setWorkingMemory (WorkingMemoryPrx _wm, Current __current) |
| WorkingMemoryAttachedComponent () | |
| final boolean | existsOnWorkingMemory (String _id) |
| final boolean | existsOnWorkingMemory (String _id, String _subarch) throws UnknownSubarchitectureException |
| final boolean | existsOnWorkingMemory (WorkingMemoryAddress _wma) throws UnknownSubarchitectureException |
| final int | getVersionNumber (String _id) throws DoesNotExistOnWMException |
| int | getVersionNumber (String _id, String _subarch) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| int | getVersionNumber (WorkingMemoryAddress _wma) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| final int | getStoredVersionNumber (String _id) throws ConsistencyException |
| final boolean | isVersioned (String _id) |
| final boolean | haveLatestVersion (String _id) throws ConsistencyException, DoesNotExistOnWMException |
| final void | checkConsistency (String _id) throws ConsistencyException, DoesNotExistOnWMException |
| void | checkConsistency (String _id, String _subarch) throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException |
| boolean | haveLatestVersion (String _id, String _subarch) throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException |
| void | checkConsistency (WorkingMemoryAddress _wma) throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException |
| void | lockEntry (String _id, String _subarch, WorkingMemoryPermissions _permissions) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| void | lockEntry (WorkingMemoryAddress _wma, WorkingMemoryPermissions _permissions) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| void | unlockEntry (WorkingMemoryAddress _wma) throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException |
| void | unlockEntry (String _id, String _subarch) throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException |
| boolean | tryLockEntry (String _id, String _subarch, WorkingMemoryPermissions _permissions) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| boolean | tryLockEntry (WorkingMemoryAddress _wma, WorkingMemoryPermissions _permissions) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| WorkingMemoryPermissions | getPermissions (String _id, String _subarch) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| WorkingMemoryPermissions | getPermissions (WorkingMemoryAddress _wma) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| boolean | isOverwritable (String _id, String _subarch) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| boolean | isDeletable (String _id, String _subarch) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| boolean | isReadable (String _id, String _subarch) throws DoesNotExistOnWMException, UnknownSubarchitectureException |
| void | unlockEntry (String _id) throws ConsistencyException, DoesNotExistOnWMException |
| void | lockEntry (String _id, WorkingMemoryPermissions _permissions) throws DoesNotExistOnWMException |
| void | tryLockEntry (String _id, WorkingMemoryPermissions _permissions) throws DoesNotExistOnWMException |
| boolean | isOverwritable (String _id) throws WMException |
| boolean | isDeletable (String _id) throws WMException |
| boolean | isReadable (String _id) throws WMException |
| WorkingMemoryPermissions | getPermissions (String _id) throws WMException |
| boolean | holdsLock (String _id) |
| boolean | holdsLock (String _id, String _subarch) |
| boolean | holdsOverwriteLock (String _id) |
| boolean | holdsDeleteLock (String _id) |
| boolean | holdsReadLock (String _id) |
| boolean | holdsOverwriteLock (String _id, String _subarch) |
| boolean | holdsDeleteLock (String _id, String _subarch) |
| boolean | holdsReadLock (String _id, String _subarch) |
Protected Member Functions | |
| void | configureInternal (Map< String, String > _config) |
| final void | storeVersionNumber (String _id, int _version) |
| final void | startVersioning (String _id) |
| final void | updateVersion (String _id, int _newVersion) |
| final void | increaseStoredVersion (String _id) throws ConsistencyException |
| final void | stopVersioning (String _id) |
| final void | removeVersionNumber (String _id) |
| boolean | needsConsistencyCheck (String _id) |
| boolean | needsConsistencyCheck (String _id, String _subarch) |
| void | consistencyChecked (String _id) |
| void | consistencyChecked (String _id, String _subarch) |
Protected Attributes | |
| WorkingMemoryPrx | m_workingMemory |
Definition at line 33 of file WorkingMemoryAttachedComponent.java.
| cast.architecture.WorkingMemoryAttachedComponent.WorkingMemoryAttachedComponent | ( | ) |
| void cast.architecture.WorkingMemoryAttachedComponent.checkConsistency | ( | WorkingMemoryAddress | _wma | ) | throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException |
Checks whether this component has read the more recent version of the data at this working memory address, and throws and exception if not.
| _wma |
| ConsistencyException | if the id is not versioned, or if the | |
| DoesNotExistOnWMException | if the _id does not exist on wm | |
| UnknownSubarchitectureException | ||
| SubarchitectureProcessException | if communication goes awry |
Definition at line 405 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.checkConsistency | ( | String | _id, | |
| String | _subarch | |||
| ) | throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException |
Checks whether this component has read the more recent version of the data at this working memory address, and throws and exception if not.
| _id | ||
| _subarch |
| ConsistencyException | if the id is not versioned | |
| DoesNotExistOnWMException | ||
| UnknownSubarchitectureException |
Definition at line 342 of file WorkingMemoryAttachedComponent.java.
| final void cast.architecture.WorkingMemoryAttachedComponent.checkConsistency | ( | String | _id | ) | throws ConsistencyException, DoesNotExistOnWMException |
Checks whether this component has read the more recent version of the data at this working memory address, and throws and exception if not.
| _id |
| ConsistencyException | if the id is not versioned, or if the | |
| DoesNotExistOnWMException | if the _id does not exist on wm |
Definition at line 321 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.configureInternal | ( | Map< String, String > | _config | ) | [protected] |
Overrides the configure method from FrameworkProcess to use _config to set the subarchitecture ID.
| _config | The ID of the subarchitecture which contains this component. |
Reimplemented from cast.core.SubarchitectureComponent.
Reimplemented in cast.architecture.WorkingMemoryWriterComponent.
Definition at line 57 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.consistencyChecked | ( | String | _id, | |
| String | _subarch | |||
| ) | [protected] |
Definition at line 889 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.consistencyChecked | ( | String | _id | ) | [protected] |
Definition at line 885 of file WorkingMemoryAttachedComponent.java.
| final boolean cast.architecture.WorkingMemoryAttachedComponent.existsOnWorkingMemory | ( | WorkingMemoryAddress | _wma | ) | throws UnknownSubarchitectureException |
Determines whether an entry exists on working memory at the given address.
| _wma | The address for the entry in working memory. |
| UnknownSubarchitectureException |
Definition at line 111 of file WorkingMemoryAttachedComponent.java.
| final boolean cast.architecture.WorkingMemoryAttachedComponent.existsOnWorkingMemory | ( | String | _id, | |
| String | _subarch | |||
| ) | throws UnknownSubarchitectureException |
Determines whether an entry exists on working memory at the given address.
| _subarch | The subarchitecture in which the id is located. | |
| _id | The id for the entry in working memory. |
| UnknownSubarchitectureException |
Definition at line 91 of file WorkingMemoryAttachedComponent.java.
| final boolean cast.architecture.WorkingMemoryAttachedComponent.existsOnWorkingMemory | ( | String | _id | ) |
Determines whether an entry exists on working memory at the given local address.
| _id | The id for the entry in working memory. |
Definition at line 70 of file WorkingMemoryAttachedComponent.java.
| WorkingMemoryPermissions cast.architecture.WorkingMemoryAttachedComponent.getPermissions | ( | String | _id | ) | throws WMException |
Gets the permissions currently set on the given working memory item.
| _id |
| WMException |
Definition at line 761 of file WorkingMemoryAttachedComponent.java.
| WorkingMemoryPermissions cast.architecture.WorkingMemoryAttachedComponent.getPermissions | ( | WorkingMemoryAddress | _wma | ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Gets the permissions currently set on the given working memory item.
| _wma |
Definition at line 571 of file WorkingMemoryAttachedComponent.java.
| WorkingMemoryPermissions cast.architecture.WorkingMemoryAttachedComponent.getPermissions | ( | String | _id, | |
| String | _subarch | |||
| ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Gets the permissions currently set on the given working memory item.
| _id | ||
| _subarch |
Definition at line 555 of file WorkingMemoryAttachedComponent.java.
| final int cast.architecture.WorkingMemoryAttachedComponent.getStoredVersionNumber | ( | String | _id | ) | throws ConsistencyException |
Get the version number currently stored in the component for the wm id.
| _id |
| ConsistencyException | if the id is not stored. |
Definition at line 206 of file WorkingMemoryAttachedComponent.java.
| int cast.architecture.WorkingMemoryAttachedComponent.getVersionNumber | ( | WorkingMemoryAddress | _wma | ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Get a count of the number of times the working memory entry at the given address has been overwritten.
| _wma | The address for the entry in working memory. |
| DoesNotExistOnWMException | if the entry does not exist on working memory. | |
| UnknownSubarchitectureException | ||
| SubarchitectureProcessException | if communication goes awry |
Definition at line 182 of file WorkingMemoryAttachedComponent.java.
| int cast.architecture.WorkingMemoryAttachedComponent.getVersionNumber | ( | String | _id, | |
| String | _subarch | |||
| ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Get a count of the number of times the working memory entry at the given address has been overwritten.
| _subarch | The subarchitecture in which the id is located. | |
| _id | The id for the entry in working memory. |
| DoesNotExistOnWMException | if the entry has never existed on working memory. | |
| UnknownSubarchitectureException |
Definition at line 155 of file WorkingMemoryAttachedComponent.java.
| final int cast.architecture.WorkingMemoryAttachedComponent.getVersionNumber | ( | String | _id | ) | throws DoesNotExistOnWMException |
Get a count of the number of times the working memory entry at the given address has been overwritten.
| _id | The id for the entry in working memory. |
| DoesNotExistOnWMException | if the entry has never existed on working memory. |
Definition at line 131 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.haveLatestVersion | ( | String | _id, | |
| String | _subarch | |||
| ) | throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException |
Checks whether this component has read the more recent version of the data at this working memory address.
| _id | ||
| _subarch |
| ConsistencyException | if the id is not versioned. | |
| DoesNotExistOnWMException | if the _id does not exist on wm | |
| UnknownSubarchitectureException |
Definition at line 380 of file WorkingMemoryAttachedComponent.java.
| final boolean cast.architecture.WorkingMemoryAttachedComponent.haveLatestVersion | ( | String | _id | ) | throws ConsistencyException, DoesNotExistOnWMException |
Checks whether this component has read the more recent version of the data at this working memory address.
| _id |
| ConsistencyException | if the id is not versioned. | |
| DoesNotExistOnWMException | if the _id does not exist on wm |
Definition at line 301 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.holdsDeleteLock | ( | String | _id, | |
| String | _subarch | |||
| ) |
Checks whether this component holds a delete lock on the given working memory item.
| _id | ||
| _subarch |
Definition at line 855 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.holdsDeleteLock | ( | String | _id | ) |
Checks whether this component holds a delete lock on the given working memory item.
| _id |
Definition at line 813 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.holdsLock | ( | String | _id, | |
| String | _subarch | |||
| ) |
Checks whether this component holds any kind of lock on the given working memory item.
| _id | ||
| _subarch |
Definition at line 790 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.holdsLock | ( | String | _id | ) |
Checks whether this component holds any kind of lock on the given working memory item.
| _id |
Definition at line 778 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.holdsOverwriteLock | ( | String | _id, | |
| String | _subarch | |||
| ) |
Checks whether this component holds an overwrite lock on the given working memory item.
| _id | ||
| _subarch |
Definition at line 842 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.holdsOverwriteLock | ( | String | _id | ) |
Checks whether this component holds an overwrite lock on the given working memory item.
| _id |
Definition at line 801 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.holdsReadLock | ( | String | _id, | |
| String | _subarch | |||
| ) |
Checks whether this component holds a read lock on the given working memory item.
| _id | ||
| _subarch |
Definition at line 870 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.holdsReadLock | ( | String | _id | ) |
Checks whether this component holds a read lock on the given working memory item.
| _id |
Definition at line 827 of file WorkingMemoryAttachedComponent.java.
| final void cast.architecture.WorkingMemoryAttachedComponent.increaseStoredVersion | ( | String | _id | ) | throws ConsistencyException [protected] |
Increment the stored version number by 1.
| _id | id of entry |
| ConsistencyException | if _id is not stored in the versioning system |
Definition at line 254 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.isDeletable | ( | String | _id | ) | throws WMException |
Checks whether a given item on working memory is currently deletable by this component.
| _id |
| WMException |
Definition at line 728 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.isDeletable | ( | String | _id, | |
| String | _subarch | |||
| ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Checks whether a given item on working memory is currently deletable by this component.
| _id | ||
| _subarch |
Definition at line 610 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.isOverwritable | ( | String | _id | ) | throws WMException |
Checks whether a given item on working memory is currently overwritable by this component.
| _id |
| WMException |
Definition at line 711 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.isOverwritable | ( | String | _id, | |
| String | _subarch | |||
| ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Checks whether a given item on working memory is currently overwritable by this component.
| _id | ||
| _subarch |
Definition at line 588 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.isReadable | ( | String | _id | ) | throws WMException |
Checks whether a given item on working memory is currently readable by this component.
| _id |
| WMException |
Definition at line 745 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.isReadable | ( | String | _id, | |
| String | _subarch | |||
| ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Checks whether a given item on working memory is currently readable by this component.
| _id | ||
| _subarch |
Definition at line 630 of file WorkingMemoryAttachedComponent.java.
| final boolean cast.architecture.WorkingMemoryAttachedComponent.isVersioned | ( | String | _id | ) |
Check whether the given id is versioned.
| _id |
Definition at line 266 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.lockEntry | ( | String | _id, | |
| WorkingMemoryPermissions | _permissions | |||
| ) | throws DoesNotExistOnWMException |
Obtain a lock on a working memory entry with the given permissions. This will block until the desired lock is obtained.
| _id | The id of the item on working memory. | |
| _permissions | The permissions to obtain. |
| DoesNotExistOnWMException | If the item does not exist on wm. |
Definition at line 669 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.lockEntry | ( | WorkingMemoryAddress | _wma, | |
| WorkingMemoryPermissions | _permissions | |||
| ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Try to obtain a lock on a working memory entry with the given permissions. This will block until the desired lock is obtained.
| _wma | ||
| _permissions |
| UnknownSubarchitectureException |
Definition at line 443 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.lockEntry | ( | String | _id, | |
| String | _subarch, | |||
| WorkingMemoryPermissions | _permissions | |||
| ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Try to obtain a lock on a working memory entry with the given permissions. This will block until the desired lock is obtained.
| _id | ||
| _subarch | ||
| _permissions |
Definition at line 421 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.needsConsistencyCheck | ( | String | _id, | |
| String | _subarch | |||
| ) | [protected] |
Definition at line 881 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.needsConsistencyCheck | ( | String | _id | ) | [protected] |
Definition at line 877 of file WorkingMemoryAttachedComponent.java.
| final void cast.architecture.WorkingMemoryAttachedComponent.removeVersionNumber | ( | String | _id | ) | [protected] |
Removes the given id from the internal versioning system storage.
| _id |
Definition at line 286 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.setWorkingMemory | ( | WorkingMemoryPrx | _wm, | |
| Current | __current | |||
| ) |
Reimplemented in cast.architecture.WorkingMemoryReaderComponent, and cast.architecture.WorkingMemoryWriterComponent.
Definition at line 39 of file WorkingMemoryAttachedComponent.java.
| final void cast.architecture.WorkingMemoryAttachedComponent.startVersioning | ( | String | _id | ) | [protected] |
Add the given id to the versioning system with version 0.
| _id |
Definition at line 223 of file WorkingMemoryAttachedComponent.java.
| final void cast.architecture.WorkingMemoryAttachedComponent.stopVersioning | ( | String | _id | ) | [protected] |
Removes the given id from the versioning system.
| _id |
Definition at line 275 of file WorkingMemoryAttachedComponent.java.
| final void cast.architecture.WorkingMemoryAttachedComponent.storeVersionNumber | ( | String | _id, | |
| int | _version | |||
| ) | [protected] |
Associate the given id with the given version number. This should not be called by user code.
| _id | ||
| _version |
Definition at line 194 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.tryLockEntry | ( | String | _id, | |
| WorkingMemoryPermissions | _permissions | |||
| ) | throws DoesNotExistOnWMException |
Try to obtain a lock on a working memory entry. This will return true if the item is locked, or false if not. This method does not block.
| _id | The id of the item on working memory. | |
| _permissions | The permissions to obtain. |
| DoesNotExistOnWMException | ||
| DoesNotExistOnWMException | If the item does not exist on wm. |
Definition at line 691 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.tryLockEntry | ( | WorkingMemoryAddress | _wma, | |
| WorkingMemoryPermissions | _permissions | |||
| ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Try to obtain a lock on a working memory entry. This will return true if the item is locked, or false if not. This method does not block.
| _wma | ||
| _permissions |
Definition at line 540 of file WorkingMemoryAttachedComponent.java.
| boolean cast.architecture.WorkingMemoryAttachedComponent.tryLockEntry | ( | String | _id, | |
| String | _subarch, | |||
| WorkingMemoryPermissions | _permissions | |||
| ) | throws DoesNotExistOnWMException, UnknownSubarchitectureException |
Try to obtain a lock on a working memory entry. This will return true if the item is locked, or false if not. This method does not block.
| _id | ||
| _subarch | ||
| _permissions |
| DoesNotExistOnWMException | ||
| UnknownSubarchitectureException | ||
| SubarchitectureProcessException |
Definition at line 510 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.unlockEntry | ( | String | _id | ) | throws ConsistencyException, DoesNotExistOnWMException |
Unlock the given working memory entry.
| _id |
| DoesNotExistOnWMException | ||
| ConsistencyException |
Definition at line 647 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.unlockEntry | ( | String | _id, | |
| String | _subarch | |||
| ) | throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException |
Unlock the given working memory entry.
| _id | ||
| _subarch |
| DoesNotExistOnWMException | ||
| ConsistencyException | ||
| UnknownSubarchitectureException | ||
| WMException |
Definition at line 473 of file WorkingMemoryAttachedComponent.java.
| void cast.architecture.WorkingMemoryAttachedComponent.unlockEntry | ( | WorkingMemoryAddress | _wma | ) | throws ConsistencyException, DoesNotExistOnWMException, UnknownSubarchitectureException |
Unlock the given working memory entry.
| _wma |
Definition at line 457 of file WorkingMemoryAttachedComponent.java.
| final void cast.architecture.WorkingMemoryAttachedComponent.updateVersion | ( | String | _id, | |
| int | _newVersion | |||
| ) | [protected] |
Updates the stored id with a new version number.
| _id | ||
| _newVersion |
Definition at line 234 of file WorkingMemoryAttachedComponent.java.
Definition at line 37 of file WorkingMemoryAttachedComponent.java.
1.5.8