frepple::utils::HasHierarchy< T > Class Template Reference

This is a base class for the main objects. More...

#include <utils.h>

Inheritance diagram for frepple::utils::HasHierarchy< T >:

List of all members.

Classes

class  memberIterator
 This class models an STL-like iterator that allows us to iterate over the members. More...

Public Member Functions

void beginElement (XMLInput &, const Attribute &)
memberIterator beginMember () const
void endElement (XMLInput &, const Attribute &, const DataElement &)
memberIterator endMember () const
unsigned short getHierarchyLevel () const
T * getOwner () const
 HasHierarchy (const string &n)
bool hasOwner () const
bool isGroup () const
void setOwner (T *f)
void writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const
 ~HasHierarchy ()

Friends

class memberIterator

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 4826 of file utils.h.


Constructor & Destructor Documentation

template<class T>
frepple::utils::HasHierarchy< T >::HasHierarchy ( const string &  n  )  [inline]

The one and only constructor.

Definition at line 4885 of file utils.h.

template<class T >
frepple::utils::HasHierarchy< T >::~HasHierarchy (  )  [inline]

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 5496 of file utils.h.


Member Function Documentation

template<class T >
void frepple::utils::HasHierarchy< T >::beginElement ( XMLInput ,
const Attribute  
) [inline, virtual]

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.

Reimplemented in frepple::Location, frepple::Customer, frepple::Item, frepple::Buffer, frepple::Resource, frepple::Demand, and module_forecast::Forecast.

Definition at line 5466 of file utils.h.

template<class T>
memberIterator frepple::utils::HasHierarchy< T >::beginMember (  )  const [inline]

Definition at line 4896 of file utils.h.

template<class T >
void frepple::utils::HasHierarchy< T >::endElement ( XMLInput ,
const Attribute ,
const DataElement  
) [inline, virtual]

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 >.

Reimplemented in frepple::Location, frepple::Customer, frepple::Item, frepple::Buffer, frepple::BufferProcure, frepple::Resource, frepple::Demand, and module_forecast::Forecast.

Definition at line 5476 of file utils.h.

template<class T>
memberIterator frepple::utils::HasHierarchy< T >::endMember (  )  const [inline]

Definition at line 4898 of file utils.h.

template<class T >
unsigned short frepple::utils::HasHierarchy< T >::getHierarchyLevel (  )  const [inline]

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 5530 of file utils.h.

template<class T>
T* frepple::utils::HasHierarchy< T >::getOwner (  )  const [inline]

Returns the owning entity.

Definition at line 4917 of file utils.h.

template<class T>
bool frepple::utils::HasHierarchy< T >::hasOwner (  )  const [inline]

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 4904 of file utils.h.

template<class T>
bool frepple::utils::HasHierarchy< T >::isGroup (  )  const [inline]

Returns true if this entity has lower level entities belonging to it.

Definition at line 4908 of file utils.h.

template<class T>
void frepple::utils::HasHierarchy< T >::setOwner ( T *  f  )  [inline]

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 5397 of file utils.h.

template<class T >
void frepple::utils::HasHierarchy< T >::writeElement ( XMLOutput ,
const Keyword ,
mode  = DEFAULT 
) const [inline, virtual]

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.

Reimplemented in frepple::Location, frepple::Customer, frepple::Item, frepple::Buffer, frepple::BufferInfinite, frepple::BufferProcure, frepple::Resource, frepple::ResourceInfinite, frepple::Demand, and module_forecast::Forecast.

Definition at line 5446 of file utils.h.


Friends And Related Function Documentation

template<class T>
friend class memberIterator [friend]

Definition at line 4835 of file utils.h.


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

Documentation generated for frePPLe by  doxygen