genNamedObj

template < class X > class genNamedObj

Template for genNamedObj

Inheritance:

Public Methods
static void add( const char *name, X x ): Adds the object X with the name to the container
inline static X begin(): Returns the first object
inline static X end(): Returns the position after the last object (i
static bool exists( const char *name ): Returns true of the object with this name exists
genNamedObj( const char *name, X x): Constructor that add the named object x into the container
static X get( const char *name ): Returns the object of a given name or NULL if it does not exists
int getLocation(): Returns the location of the object within the map - i
inline static int getNbElements(): Returns the number of objects in the container
static X getObject( const char *name ): Returns the object of a given name or NULL if it does not exists
static int getObjects( const char *name, list<X> &theList ): Given a tag (such as "object*") find all objects that contain this string and return them in a linked list
inline const char* getObjName(): Returns the name of the object
inline static X next(): Returns the next object
static void remove( const char *name ): Removes the named object from the list
~genNamedObj(): Dtor

Private Fields
static map < const char*, X, cstring_ordering_t > ::iterator m_It: iterator that is used internally when looping over all objects
static map < const char*, X, cstring_ordering_t > m_Map: map with all the elements
char* m_Name: Name of the object

Documentation

Template for genNamedObj.
This template supports the store, retrieval and location of named objects. A named object is simply an object that has a name (in the form of a string). Internally it is implemented using the STL map container.
Typical usage:
 class XXX : public genNamedObj<X*>
 {
   XXX(const char *name, ...) : getNamedObj<X*>( name, this ) {...}
 };

 // initialize the static members
 map<const char*, X*, cstring_ordering_t> genNamedObj<XXX*>::m_Map( my_cstring_ordering );
 map<const char*, XXX*, cstring_ordering_t>::iterator genNamedObj<XXX*>::m_It = NULL;
Note that we do normally not store the object itself in the container, but only the pointer to it. The string "name" is stored and managed internally. As the container is implemented as a static map, the user has to initialize its two static members,
An working example C++ file is test_gen_named_obj.cc.
MODIFICATIONS:

genNamedObj( const char *name, X x)

Constructor that add the named object x into the container

Parameters:: name - : name of the object. A local copy of the name is made and maintained in the genNamedObj.
X - : the object. Normally the pointer to the object is passed and not the object itself in order to limit the number of copy Ctors

~genNamedObj()