Public Member Functions |
CKeyValuePair * | addDescriptionListItem (std::string strDomain, std::string strPrefix) |
void | addDesignator (std::string strType, std::list< CKeyValuePair * > lstDescription, std::string strUniqueID, std::string strAnnotation="") |
std::string | addFailure (std::string strCondition, std::string strTimestamp) |
std::string | addImage (std::string strOrigin, std::string strFilename, std::string strTimestamp) |
std::string | addObject (std::list< CKeyValuePair * > lstDescription) |
void | addSubnode (Node *ndAdd) |
| Add a sub-node to this node.
|
std::string | catchFailure (std::string strFailureID, Node *ndEmitter, std::string strTimestamp) |
std::list< CKeyValuePair * > | description () |
| Returns the node's current description.
|
Node * | emitterForCaughtFailure (std::string strFailureID, std::string strEmitterID, std::string strTimestamp) |
void | ensureProperty (std::string strKey, std::string strDefaultValue) |
bool | hasFailures () |
int | highestID () |
int | id () |
bool | includesUniqueID (std::string strUniqueID) |
CKeyValuePair * | metaInformation () |
| Node () |
| Constructur for generating an empty node.
|
| Node (std::string strTitle) |
| Constructor for generating a title'd node.
|
| Node (std::list< CKeyValuePair * > lstDescription) |
| Constructur for generating a node given an existing description.
|
Node * | parent () |
| Return this node's parent node.
|
bool | prematurelyEnded () |
Node * | previousNode () |
Node * | relativeWithID (int nID, bool bIgnoreSelf=false) |
void | removeCaughtFailure (std::string strFailureID) |
void | setDescription (std::list< CKeyValuePair * > lstDescription) |
| Sets this node's description.
|
void | setID (int nID) |
void | setParent (Node *ndParent) |
| Set this node's pointer to its parent node.
|
void | setPrematurelyEnded (bool bPrematurelyEnded) |
void | setSuccess (bool bSuccess) |
void | setTitle (std::string strTitle) |
| Set this node's title.
|
void | setUniqueID (std::string strUniqueID) |
std::list< Node * > | subnodes () |
| Return the list of sub-nodes for this node.
|
bool | success () |
std::string | title () |
| Return this node's title.
|
std::string | uniqueID () |
| ~Node () |
| Destructor, cleaning up the internal node data.
|
Private Member Functions |
void | clearDescription () |
| Deletes the internal description cache for this node.
|
void | clearSubnodes () |
| Deletes the internal sub-node references for this node.
|
void | init () |
| Central initialization method for the Node class.
|
Private Attributes |
CKeyValuePair * | m_ckvpMetaInformation |
| This nide's meta information.
|
std::list< std::pair
< std::string, Node * > > | m_lstCaughtFailures |
| List of failures caught by this node, and their emitters.
|
std::list< CKeyValuePair * > | m_lstDescription |
| List of description key/value-pairs.
|
std::list< Node * > | m_lstSubnodes |
| List of this node's sub-nodes.
|
Node * | m_ndParent |
| Pointer to the node's parent node instance.
|
int | m_nID |
| Internal counter ID.
|
std::string | m_strTitle |
| The string title of the current node.
|
std::string | m_strUniqueID |
| Unique ID for this node.
|
Class describing a single node entity.
Nodes are the basic building block of task trees. They can have (meta-)properties, a title, a unique ID, and sub nodes. They also know about their parent node to ease tree processing.
Definition at line 57 of file Node.h.