MultiAgentDecisionProcess  Release 0.2.1
JointObservationHistoryTree Class Reference

JointObservationHistoryTree is a class that represents a wrapper for the JointObservationHistory class. More...

#include <JointObservationHistoryTree.h>

+ Inheritance diagram for JointObservationHistoryTree:
+ Collaboration diagram for JointObservationHistoryTree:

Public Member Functions

JointObservationHistoryGetJointObservationHistory () const
size_t GetLength () const
 Destructor.
JointObservationHistoryTreeGetPredecessor () const
 Get the predecessor TreeNode*.
JointObservationHistoryTreeGetSuccessor (Index jObsI)
 Get the succesor TreeNode* for the sucI'th successor.
 JointObservationHistoryTree (JointObservationHistory *const joh)
 Create a joint observation history tree for joh.
 JointObservationHistoryTree (const JointObservationHistoryTree &a)
 Copy constructor.
- Public Member Functions inherited from TreeNode< JointObservationHistory >
bool ExistsSuccessor (Index sucI)
 Check whether a particular successor sucI exists.
JointObservationHistoryGetContainedElement () const
 Returns a pointer to the contained element (Tcontained)
Index GetIndex () const
 Returns the index of this TreeNode (and thus corresponding to the contained element).
void Print () const
 Prints the tree starting from this node of the history tree (including the successors).
void PrintThisNode () const
 Prints only this node of the history tree (not the successors).
void SetIndex (Index i)
 Sets the index to i.
void SetPredeccessor (TreeNode< JointObservationHistory > *pred)
 Sets the predecessor of this node to be pred.
void SetSuccessor (Index sucI, TreeNode< JointObservationHistory > *suc)
 Sets the sucI'th successor of this TreeNode to suc.
 TreeNode ()
 (default) Constructor
 TreeNode (JointObservationHistory *const oh)
 TreeNode (const TreeNode &a)
 Copy constructor.
virtual ~TreeNode ()
 Destructor.

Additional Inherited Members

- Protected Attributes inherited from TreeNode< JointObservationHistory >
JointObservationHistory_m_containedElem
 The contained element.
Index _m_index
 The index of this TreeNode (and thus of the contained Tcontained - typically an observation history).
bool _m_indexValid
 Whether the index is valid.
TreeNode
< JointObservationHistory > * 
_m_pred
 A Pointer to the predecessor.
std::map< Index, TreeNode
< JointObservationHistory > * > 
_m_successor
 The map that stores the pointers to the successor TreeNodes.

Detailed Description

JointObservationHistoryTree is a class that represents a wrapper for the JointObservationHistory class.

An JointObservationHistoryTree actually represents a node in the tree of observation histories. But each node also specifies a (sub-)tree so there is no actual difference between a tree and a node. This implementation assumes that ObservationHistories are always contained in exactly 1 JointObservationHistoryTree: i.e., deleting an object of JointObservationHistoryTree will free the memory of the node and the subtree represented by it as well as the memory of all the contained ObservationHistories.

Definition at line 57 of file JointObservationHistoryTree.h.

Constructor & Destructor Documentation

JointObservationHistoryTree::JointObservationHistoryTree ( JointObservationHistory *const  joh)
inline

Create a joint observation history tree for joh.

Definition at line 67 of file JointObservationHistoryTree.h.

JointObservationHistoryTree::JointObservationHistoryTree ( const JointObservationHistoryTree a)
inline

Copy constructor.

Definition at line 71 of file JointObservationHistoryTree.h.

Member Function Documentation

JointObservationHistory* JointObservationHistoryTree::GetJointObservationHistory ( ) const
inline
size_t JointObservationHistoryTree::GetLength ( ) const
inline

Destructor.

Returns the length of the contained ObservationHistory.

Definition at line 83 of file JointObservationHistoryTree.h.

References TreeNode< JointObservationHistory >::GetContainedElement().

JointObservationHistoryTree* JointObservationHistoryTree::GetPredecessor ( ) const
inline

Get the predecessor TreeNode*.

Reimplemented from TreeNode< JointObservationHistory >.

Definition at line 94 of file JointObservationHistoryTree.h.

JointObservationHistoryTree* JointObservationHistoryTree::GetSuccessor ( Index  sucI)
inline

Get the succesor TreeNode* for the sucI'th successor.

Reimplemented from TreeNode< JointObservationHistory >.

Definition at line 99 of file JointObservationHistoryTree.h.


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