Link Class Reference
#include <Ample.h>
Inheritance diagram for Link:
Collaboration diagram for Link:
Classes | |
| class | Data |
Public Types | |
| typedef Observer< LinkObserver > | ObserverType |
| typedef std::vector < LinkObserver * > | ObserverList |
Public Member Functions | |
| void | destroy (void) |
| uint16 | getID (void) const |
| VNodeID | getLinkedNodeID (void) const |
| Node * | getLinkedNode (void) const |
| void | setLinkedNode (VNodeID nodeID) |
| VNodeID | getTargetNodeID (void) const |
| Node * | getTargetNode (void) const |
| void | setTargetNode (VNodeID nodeID) |
| const std::string & | getName (void) const |
| void | setName (const std::string &name) |
| ObjectNode & | getNode (void) const |
| unsigned int | getDataVersion (void) const |
| unsigned int | getStructureVersion (void) const |
| void | addObserver (LinkObserver &observer) |
| void | removeObserver (LinkObserver &observer) |
| void | removeObserver (Observer< LinkObserver > &observer) |
| const ObserverList & | getObservers (void) const |
Friends | |
| class | ObjectNode |
Member Typedef Documentation
typedef std::vector<LinkObserver *> ObserverList [inherited] |
typedef Observer<LinkObserver > ObserverType [inherited] |
Member Function Documentation
| void addObserver | ( | LinkObserver & | observer | ) | [inline, inherited] |
Adds the specified observer to this object.
- Parameters:
-
observer The observer to add.
- Remarks:
- An observer can only be added once. Additional additions are ignored.
| void destroy | ( | void | ) |
Destroys this node link.
- Remarks:
- This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.
| unsigned int getDataVersion | ( | void | ) | const [inherited] |
- Returns:
- The current version of the internal state.
- Remarks:
- This value is updated for any kind of change.
| uint16 getID | ( | void | ) | const |
- Returns:
- The ID of this node link.
| Node* getLinkedNode | ( | void | ) | const |
- Returns:
- The node that this link points to, or
NULLif the node doesn't exist.
| VNodeID getLinkedNodeID | ( | void | ) | const |
- Returns:
- The ID of the node that this node link points to.
| const std::string& getName | ( | void | ) | const |
- Returns:
- The name of this node.
| ObjectNode& getNode | ( | void | ) | const |
- Returns:
- The node containing this node link.
| const ObserverList& getObservers | ( | void | ) | const [inline, inherited] |
- Returns:
- The list of observers attached to this object.
| unsigned int getStructureVersion | ( | void | ) | const [inherited] |
- Returns:
- The current version of the internal structure.
- Remarks:
- This value is only updated when the internal structure changes.
| Node* getTargetNode | ( | void | ) | const |
- Returns:
- The "who knows" that this link points to, or
NULLif the node doesn't exist.
| VNodeID getTargetNodeID | ( | void | ) | const |
- Returns:
- The ID of "who knows".
| void removeObserver | ( | Observer< LinkObserver > & | observer | ) | [inline, inherited] |
Removes the specified observer from this object.
- Parameters:
-
observer The observer to remove.
| void removeObserver | ( | LinkObserver & | observer | ) | [inline, inherited] |
Removes the specified observer from this object.
- Parameters:
-
observer The observer to remove.
| void setLinkedNode | ( | VNodeID | nodeID | ) |
| void setName | ( | const std::string & | name | ) |
| void setTargetNode | ( | VNodeID | nodeID | ) |
Friends And Related Function Documentation
friend class ObjectNode [friend] |
Reimplemented from Versioned.
