List of all members.
Detailed Description
template<class T>
class frepple::utils::HasHierarchy< T >
This is a base class for the main objects.
Instances of this class have the following properties:
- Unique name and global hashtable are inherited from the class HasName.
- Instances build up hierarchical trees of arbitrary depth.
- Each object can have a single parent only.
- Each object has a parent and can have children. This class thus implements the 'composite' design pattern. The internal data structure is a singly linked linear list, which is efficient provided the number of childre remains limited.
Definition at line 4657 of file utils.h.
Constructor & Destructor Documentation
The one and only constructor.
Definition at line 4716 of file utils.h.
Destructor. When deleting a node of the hierarchy, the children will get the current parent as the new parent. In this way the deletion of nodes doesn't create "dangling branches" in the hierarchy. We just "collapse" a certain level.
Definition at line 141 of file utils.h.
Member Function Documentation
Called while restoring the model from an XML-file.
This is called for each element within the "this" element, for which the "this" element is immediate parent.
It is called when the open element tag is encountered.
Reimplemented from frepple::utils::Object.
Definition at line 111 of file utils.h.
Called while restoring the model from an XML-file.
This is called when the corresponding close element tag is encountered, and the Data() member of pElement is valid.
Reimplemented from frepple::utils::HasName< T >.
Definition at line 121 of file utils.h.
Returns the level in the hierarchy.
Level 0 means the entity doesn't have any parent.
Level 1 means the entity has a parent entity with level 0.
Level "x" means the entity has a parent entity whose level is "x-1".
Definition at line 175 of file utils.h.
Returns the owning entity.
Definition at line 4748 of file utils.h.
Returns true if this entity belongs to a higher hierarchical level.
An entity can have only a single owner, and can't belong to multiple hierarchies.
Definition at line 4735 of file utils.h.
Returns true if this entity has lower level entities belonging to it.
Definition at line 4739 of file utils.h.
Changes the owner of the entity.
The argument must be a valid pointer to an entity of the same type.
A NULL pointer can be passed to clear the existing owner.
Definition at line 42 of file utils.h.
Called while writing the model into an XML-file. The user class should write itself out, using the IOutStream members for its "simple" members and calling writeElement recursively for any contained objects. Not all classes are expected to implement this method. In instances of such a class can be created but can't be persisted. E.g. Command
Note that this function is never called on its own. It is always called from the writeElement() method of a subclass. Therefore we don't need to worry about the refOnly or incHeader parameters.
Reimplemented from frepple::utils::Object.
Definition at line 91 of file utils.h.
Friends And Related Function Documentation
The documentation for this class was generated from the following files: