| 1 | /*! |
|---|
| 2 | * @file class_list.h |
|---|
| 3 | * Definition of the Class List, that handles a Class-Specific-Control structure |
|---|
| 4 | |
|---|
| 5 | */ |
|---|
| 6 | |
|---|
| 7 | #ifndef _CLASS_LIST_H |
|---|
| 8 | #define _CLASS_LIST_H |
|---|
| 9 | |
|---|
| 10 | #include "class_id.h" |
|---|
| 11 | #include <list> |
|---|
| 12 | #ifndef NULL |
|---|
| 13 | #define NULL 0 //!< NULL |
|---|
| 14 | #endif |
|---|
| 15 | |
|---|
| 16 | // FORWARD DECLARATION |
|---|
| 17 | class BaseObject; |
|---|
| 18 | |
|---|
| 19 | //! A class that handles Pointers to Objects of all type. |
|---|
| 20 | /** |
|---|
| 21 | * here all the Pointers to all the Object of orxonox are stored, that implement BaseObject |
|---|
| 22 | * for now. |
|---|
| 23 | * You can get Any Object's Reference to BaseObject with dynamic_cast<T>(ClassList::getObject(name, CL_T_NAME)); |
|---|
| 24 | * where: T: is the Class to cast to, |
|---|
| 25 | * name: the name of the Object (not className) |
|---|
| 26 | * CL_T_NAME: the class Identifier, (if CL_NULL or nothing it will take longer, because all BaseObject's are searched through) |
|---|
| 27 | * |
|---|
| 28 | * There is also the exists-function, that just checks, if a Reference is still in existence. |
|---|
| 29 | * |
|---|
| 30 | * @see ClassID, BaseObject, dynamic_cast |
|---|
| 31 | */ |
|---|
| 32 | class ClassList { |
|---|
| 33 | |
|---|
| 34 | public: |
|---|
| 35 | ClassList(const long& classID, const char* className); |
|---|
| 36 | virtual ~ClassList(); |
|---|
| 37 | |
|---|
| 38 | // STATIC FUNCTIONS |
|---|
| 39 | static void addToClassList(BaseObject* objectPointer, ClassID classID, const char* className); |
|---|
| 40 | static void removeFromClassList(BaseObject* objectPointer); |
|---|
| 41 | |
|---|
| 42 | static const std::list<BaseObject*>* getList(ClassID classID = CL_NULL);// { return (ClassList* fl = ClassList::getClassList(classID) != NULL)? &(fl->objectList) : NULL; }; |
|---|
| 43 | static const std::list<BaseObject*>* getList(const char* className); // { return (ClassList* fl = ClassList::getClassList(className) != NULL)? &(fl->objectList) : NULL; }; |
|---|
| 44 | static const std::list<const char*>* getClassNames(); |
|---|
| 45 | static BaseObject* getObject(const char* name, ClassID classID = CL_NULL); |
|---|
| 46 | static bool exists(const BaseObject* object, ClassID classID = CL_NULL); |
|---|
| 47 | |
|---|
| 48 | void sendBack(std::list<BaseObject*>::const_iterator it); |
|---|
| 49 | |
|---|
| 50 | static void whatIs(const BaseObject* object); |
|---|
| 51 | |
|---|
| 52 | static const char* IDToString(ClassID classID = CL_NULL); |
|---|
| 53 | static long StringToID(const char* className); |
|---|
| 54 | static void debug(unsigned int debugLevel = 0, long classID = CL_NULL); |
|---|
| 55 | static void debugS(const char* className = NULL, unsigned int debugLevel = 0); |
|---|
| 56 | |
|---|
| 57 | inline bool operator==(ClassID classID) { return (this->classID == classID); }; |
|---|
| 58 | bool operator==(const char* className); |
|---|
| 59 | |
|---|
| 60 | private: |
|---|
| 61 | static ClassList* getClassList(ClassID classID); |
|---|
| 62 | static ClassList* getClassList(const char* className); |
|---|
| 63 | |
|---|
| 64 | private: |
|---|
| 65 | |
|---|
| 66 | long classID; //!< ClassID stored in this ClassList \see ClassID |
|---|
| 67 | const char* className; //!< Name of the Class Stored here |
|---|
| 68 | |
|---|
| 69 | std::list<BaseObject*> objectList; //!< A list of Objects belonging to this Class |
|---|
| 70 | |
|---|
| 71 | // STATIC MEMBERS |
|---|
| 72 | static std::list<ClassList>* classList; //!< The first Class in the List |
|---|
| 73 | static std::list<const char*> classNames; //!< a List of all Names of all classes, that have registered so far. |
|---|
| 74 | }; |
|---|
| 75 | |
|---|
| 76 | #endif /* _CLASS_LIST_H */ |
|---|
