User Manual, Developers Guide and API Documentation

wns::container::SingleFastListEnabler< T > Class Template Reference

Derive from this class be able to put pointers of the child class into FastList containers. More...

#include <container/FastListEnabler.hpp>

Inheritance diagram for wns::container::SingleFastListEnabler< T >:

Inheritance graph
[legend]
Collaboration diagram for wns::container::SingleFastListEnabler< T >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

FastListNode< T > * getFastListNode (FastList< T > *l) const
 Return the FastListNode.
bool isInList (FastList< T > *f) const
 Is this object in FastList "f".
void removeFastListNode (FastList< T > *f)
 Remove this object from the FastList.
void removeFromAllLists ()
 Remove this Node from all lists where it is contained.
void setFastListNode (FastList< T > *f, FastListNode< T > *FLN)
 Set the FastListNode for s FastList.
 SingleFastListEnabler ()
 Default constructor.
virtual ~SingleFastListEnabler ()
 Destructor - removes from object from the FastList.

Private Attributes

FastList< T > * list
 The list this object is part of.
FastListNode< T > * node
 The FastListNode belonging to the FastList this object is part of.


Detailed Description

template<typename T>
class wns::container::SingleFastListEnabler< T >

Author:
Marc Schinnenburg <marc@schinnenburg.com>
Note:
This Enabler is considerably faster than the one above. As drawback you may only be in one list at a time

Definition at line 137 of file FastListEnabler.hpp.


Constructor & Destructor Documentation

template<typename T>
wns::container::SingleFastListEnabler< T >::SingleFastListEnabler (  )  [inline]

Definition at line 144 of file FastListEnabler.hpp.

template<typename T>
virtual wns::container::SingleFastListEnabler< T >::~SingleFastListEnabler (  )  [inline, virtual]

Definition at line 152 of file FastListEnabler.hpp.


Member Function Documentation

template<typename T>
FastListNode<T>* wns::container::SingleFastListEnabler< T >::getFastListNode ( FastList< T > *  l  )  const [inline]

Definition at line 161 of file FastListEnabler.hpp.

template<typename T>
bool wns::container::SingleFastListEnabler< T >::isInList ( FastList< T > *  f  )  const [inline]

Definition at line 214 of file FastListEnabler.hpp.

template<typename T>
void wns::container::SingleFastListEnabler< T >::removeFastListNode ( FastList< T > *  f  )  [inline]

Definition at line 188 of file FastListEnabler.hpp.

template<typename T>
void wns::container::SingleFastListEnabler< T >::removeFromAllLists (  )  [inline]

Definition at line 203 of file FastListEnabler.hpp.

template<typename T>
void wns::container::SingleFastListEnabler< T >::setFastListNode ( FastList< T > *  f,
FastListNode< T > *  FLN 
) [inline]

Definition at line 174 of file FastListEnabler.hpp.


Member Data Documentation

template<typename T>
FastList<T>* wns::container::SingleFastListEnabler< T >::list [private]

Definition at line 223 of file FastListEnabler.hpp.

template<typename T>
FastListNode<T>* wns::container::SingleFastListEnabler< T >::node [private]

Definition at line 229 of file FastListEnabler.hpp.


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

Generated on Sat May 26 03:32:52 2012 for openWNS by  doxygen 1.5.5