VIEW::CompositeManager Class Reference
[Other classes]

Management of Composites. More...

#include <compositeManager.h>

List of all members.

Public Types
Typedefs for STL compliance
typedef Composite *	value_type
typedef Composite *&	reference
typedef Composite **	pointer
typedef const Composite *&	const_reference
typedef const Composite **	const_pointer
typedef Index	difference_type
typedef Size	size_type
typedef HashSet< Composite * >::Iterator	iterator
typedef HashSet< Composite * >::Iterator	CompositeIterator
typedef HashSet< Composite * >::ConstIterator	CompositeConstIterator
Public Member Functions
Constructors and Destructors
	CompositeManager () throw ()
	Default Constructor.
	CompositeManager (const CompositeManager &cm) throw ()
	Copy Constructor.
virtual	~CompositeManager () throw ()
	Destructor.
virtual void	clear () throw ()
	Explicit default initialization.
Predicates
bool	has (const Composite *composite) const throw ()
	Test if the CompositeManager has the Composite itself or one of its ancestors.
bool	hasRoot (const Composite *composite) const throw ()
	Test if the CompositeManager has the Composite itself as root entry (no search for childs or descendents).
Accessors: inspectors and mutators
bool	insert (Composite &composite) throw ()
	Insert a Composite.
void	remove (Composite &composite, bool to_delete=true) throw ()
	Remove a Composite.
Size	getNumberOfComposites () const throw ()
	Return the number of inserted Composites.
STL Iterator compliance
CompositeIterator	begin () throw ()
CompositeIterator	end () throw ()
CompositeConstIterator	begin () const throw ()
CompositeConstIterator	end () const throw ()
HashSet< Composite * > &	getComposites () throw ()
const HashSet< Composite * > &	getComposites () const throw ()
virtual void	dump (std::ostream &s=std::cout, Size depth=0) const throw ()
	Internal value dump.

---

Detailed Description

Management of Composites.

This class is a container for all Composite objects, which are used in an application. When the CompositeManager is destroyed, all inserted Composites are deleted.

---

Constructor & Destructor Documentation

VIEW::CompositeManager::CompositeManager (   )  throw ()

Default Constructor.

virtual VIEW::CompositeManager::~CompositeManager (   )  throw () [virtual]

Destructor.

---

Member Function Documentation

virtual void VIEW::CompositeManager::clear (   )  throw () [virtual]

Explicit default initialization.

virtual void VIEW::CompositeManager::dump (  std::ostream &  s = std::cout, Size  depth = 0 )  const throw () [virtual]

Internal value dump. Dumps the current state to a output ostream s with dumping depth depth. Parameters: s  output stream where to output the state depth  the dumping depth

bool VIEW::CompositeManager::has (  const Composite *  composite  )  const throw ()

Test if the CompositeManager has the Composite itself or one of its ancestors. This method also works if the Composite might have been deleted, but it is quite slow O(n) with n = number of all Composites !

bool VIEW::CompositeManager::hasRoot (  const Composite *  composite  )  const throw ()

Test if the CompositeManager has the Composite itself as root entry (no search for childs or descendents). Quite Fast with O(log n) with n = number of roots (Systems).

bool VIEW::CompositeManager::insert (  Composite &  composite  )  throw ()

Insert a Composite. Composites which are descendents of already inserted Composites can not be inserted. Returns: true, if the Composite could be inserted

void VIEW::CompositeManager::remove (  Composite &  composite, bool  to_delete = true )  throw ()

Remove a Composite. The Composite and its descendents will be destroyed if to_delete is true