Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/gcc43/src/core/Identifier.h @ 1615

Last change on this file since 1615 was 1581, checked in by nicolasc, 16 years ago

well, it compiles..
there are only about 1000 warinig about a deprecated header usage in ogre, and some other uglinesses, but apart from that it builds… and still seg faults…

  • Property svn:eol-style set to native
File size: 33.1 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file Identifier.h
31    @brief Definition of the Identifier, ClassIdentifier and SubclassIdentifier classes, implementation of the ClassIdentifier and SubclassIdentifier classes.
32
33    The Identifier contains all needed informations about the class it belongs to:
34     - the name
35     - a list with all objects
36     - parents and children
37     - the factory (if available)
38     - the networkID that can be synchronised with the server
39     - all configurable variables (if available)
40
41    Every object has a pointer to the Identifier of its class. This allows the use isA(...),
42    isExactlyA(...), isChildOf(...) and isParentOf(...).
43
44    To create the class-hierarchy, the Identifier has some intern functions and variables.
45
46    Every Identifier is in fact a ClassIdentifier, but they are derived from Identifier.
47
48    SubclassIdentifier is a separated class, acting like an Identifier, but has a given class.
49    You can only assign Identifiers of exactly the given class or of a derivative to a SubclassIdentifier.
50*/
51
52#ifndef _Identifier_H__
53#define _Identifier_H__
54
55#include "CorePrereqs.h"
56
57#include <set>
58#include <map>
59#include <string>
60#include <utility>
61#include <typeinfo>
62#include <stdlib.h>
63
64#include "ObjectList.h"
65#include "Debug.h"
66#include "Iterator.h"
67#include "MetaObjectList.h"
68#include "util/String.h"
69
70namespace orxonox
71{
72    // ###############################
73    // ###       Identifier        ###
74    // ###############################
75    //! The Identifier is used to identify the class of an object and to store informations about the class.
76    /**
77        The Identifier contains all needed informations about the class it belongs to:
78         - the name
79         - a list with all objects
80         - parents and childs
81         - the factory (if available)
82         - the networkID that can be synchronised with the server
83         - all configurable variables (if available)
84
85        Every object has a pointer to the Identifier of its class. This allows the use isA(...),
86        isExactlyA(...), isChildOf(...) and isParentOf(...).
87
88        You can't directly create an Identifier, it's just the base-class for ClassIdentifier.
89    */
90    class _CoreExport Identifier
91    {
92        template <class T>
93        friend class ClassIdentifier;
94
95        template <class T>
96        friend class SubclassIdentifier;
97
98        friend class Factory;
99
100        public:
101            /** @brief Sets the Factory. @param factory The factory to assign */
102            inline void addFactory(BaseFactory* factory) { this->factory_ = factory; }
103
104            BaseObject* fabricate();
105            bool isA(const Identifier* identifier) const;
106            bool isExactlyA(const Identifier* identifier) const;
107            bool isChildOf(const Identifier* identifier) const;
108            bool isDirectChildOf(const Identifier* identifier) const;
109            bool isParentOf(const Identifier* identifier) const;
110            bool isDirectParentOf(const Identifier* identifier) const;
111
112            virtual const ObjectList<BaseObject>* getObjectList() const = 0;
113
114            virtual void updateConfigValues() const = 0;
115
116            /** @brief Returns the name of the class the Identifier belongs to. @return The name */
117            inline const std::string& getName() const { return this->name_; }
118
119
120            /** @brief Returns the parents of the class the Identifier belongs to. @return The list of all parents */
121            inline const std::set<const Identifier*>& getParents() const { return this->parents_; }
122            /** @brief Returns the begin-iterator of the parents-list. @return The begin-iterator */
123            inline std::set<const Identifier*>::const_iterator getParentsBegin() const { return this->parents_.begin(); }
124            /** @brief Returns the end-iterator of the parents-list. @return The end-iterator */
125            inline std::set<const Identifier*>::const_iterator getParentsEnd() const { return this->parents_.end(); }
126
127            /** @brief Returns the children of the class the Identifier belongs to. @return The list of all children */
128            inline const std::set<const Identifier*>& getChildren() const { return (*this->children_); }
129            /** @brief Returns the begin-iterator of the children-list. @return The begin-iterator */
130            inline std::set<const Identifier*>::const_iterator getChildrenBegin() const { return this->children_->begin(); }
131            /** @brief Returns the end-iterator of the children-list. @return The end-iterator */
132            inline std::set<const Identifier*>::const_iterator getChildrenEnd() const { return this->children_->end(); }
133
134            /** @brief Returns the direct parents of the class the Identifier belongs to. @return The list of all direct parents */
135            inline const std::set<const Identifier*>& getDirectParents() const { return this->directParents_; }
136            /** @brief Returns the begin-iterator of the direct-parents-list. @return The begin-iterator */
137            inline std::set<const Identifier*>::const_iterator getDirectParentsBegin() const { return this->directParents_.begin(); }
138            /** @brief Returns the end-iterator of the direct-parents-list. @return The end-iterator */
139            inline std::set<const Identifier*>::const_iterator getDirectParentsEnd() const { return this->directParents_.end(); }
140
141            /** @brief Returns the direct children the class the Identifier belongs to. @return The list of all direct children */
142            inline const std::set<const Identifier*>& getDirectChildren() const { return (*this->directChildren_); }
143            /** @brief Returns the begin-iterator of the direct-children-list. @return The begin-iterator */
144            inline std::set<const Identifier*>::const_iterator getDirectChildrenBegin() const { return this->directChildren_->begin(); }
145            /** @brief Returns the end-iterator of the direct-children-list. @return The end-iterator */
146            inline std::set<const Identifier*>::const_iterator getDirectChildrenEnd() const { return this->directChildren_->end(); }
147
148
149            /** @brief Returns the map that stores all Identifiers. @return The map */
150            static inline const std::map<std::string, Identifier*>& getIdentifierMap() { return Identifier::getIdentifierMapIntern(); }
151            /** @brief Returns a const_iterator to the beginning of the map that stores all Identifiers. @return The const_iterator */
152            static inline std::map<std::string, Identifier*>::const_iterator getIdentifierMapBegin() { return Identifier::getIdentifierMap().begin(); }
153            /** @brief Returns a const_iterator to the end of the map that stores all Identifiers. @return The const_iterator */
154            static inline std::map<std::string, Identifier*>::const_iterator getIdentifierMapEnd() { return Identifier::getIdentifierMap().end(); }
155
156            /** @brief Returns the map that stores all Identifiers with their names in lowercase. @return The map */
157            static inline const std::map<std::string, Identifier*>& getLowercaseIdentifierMap() { return Identifier::getLowercaseIdentifierMapIntern(); }
158            /** @brief Returns a const_iterator to the beginning of the map that stores all Identifiers with their names in lowercase. @return The const_iterator */
159            static inline std::map<std::string, Identifier*>::const_iterator getLowercaseIdentifierMapBegin() { return Identifier::getLowercaseIdentifierMap().begin(); }
160            /** @brief Returns a const_iterator to the end of the map that stores all Identifiers with their names in lowercase. @return The const_iterator */
161            static inline std::map<std::string, Identifier*>::const_iterator getLowercaseIdentifierMapEnd() { return Identifier::getLowercaseIdentifierMap().end(); }
162
163
164            /** @brief Returns the map that stores all config values. @return The const_iterator */
165            inline const std::map<std::string, ConfigValueContainer*>& getConfigValueMap() const { return this->configValues_; }
166            /** @brief Returns a const_iterator to the beginning of the map that stores all config values. @return The const_iterator */
167            inline std::map<std::string, ConfigValueContainer*>::const_iterator getConfigValueMapBegin() const { return this->configValues_.begin(); }
168            /** @brief Returns a const_iterator to the end of the map that stores all config values. @return The const_iterator */
169            inline std::map<std::string, ConfigValueContainer*>::const_iterator getConfigValueMapEnd() const { return this->configValues_.end(); }
170
171            /** @brief Returns the map that stores all config values with their names in lowercase. @return The const_iterator */
172            inline const std::map<std::string, ConfigValueContainer*>& getLowercaseConfigValueMap() const { return this->configValues_LC_; }
173            /** @brief Returns a const_iterator to the beginning of the map that stores all config values with their names in lowercase. @return The const_iterator */
174            inline std::map<std::string, ConfigValueContainer*>::const_iterator getLowercaseConfigValueMapBegin() const { return this->configValues_LC_.begin(); }
175            /** @brief Returns a const_iterator to the end of the map that stores all config values with their names in lowercase. @return The const_iterator */
176            inline std::map<std::string, ConfigValueContainer*>::const_iterator getLowercaseConfigValueMapEnd() const { return this->configValues_LC_.end(); }
177
178
179            /** @brief Returns the map that stores all console commands. @return The const_iterator */
180            inline const std::map<std::string, ConsoleCommand*>& getConsoleCommandMap() const { return this->consoleCommands_; }
181            /** @brief Returns a const_iterator to the beginning of the map that stores all console commands. @return The const_iterator */
182            inline std::map<std::string, ConsoleCommand*>::const_iterator getConsoleCommandMapBegin() const { return this->consoleCommands_.begin(); }
183            /** @brief Returns a const_iterator to the end of the map that stores all console commands. @return The const_iterator */
184            inline std::map<std::string, ConsoleCommand*>::const_iterator getConsoleCommandMapEnd() const { return this->consoleCommands_.end(); }
185
186            /** @brief Returns the map that stores all console commands with their names in lowercase. @return The const_iterator */
187            inline const std::map<std::string, ConsoleCommand*>& getLowercaseConsoleCommandMap() const { return this->consoleCommands_LC_; }
188            /** @brief Returns a const_iterator to the beginning of the map that stores all console commands with their names in lowercase. @return The const_iterator */
189            inline std::map<std::string, ConsoleCommand*>::const_iterator getLowercaseConsoleCommandMapBegin() const { return this->consoleCommands_LC_.begin(); }
190            /** @brief Returns a const_iterator to the end of the map that stores all console commands with their names in lowercase. @return The const_iterator */
191            inline std::map<std::string, ConsoleCommand*>::const_iterator getLowercaseConsoleCommandMapEnd() const { return this->consoleCommands_LC_.end(); }
192
193
194            /** @brief Returns true if this class has at least one config value. @return True if this class has at least one config value */
195            inline bool hasConfigValues() const { return this->bHasConfigValues_; }
196            /** @brief Returns true if this class has at least one console command. @return True if this class has at least one console command */
197            inline bool hasConsoleCommands() const { return this->bHasConsoleCommands_; }
198
199            /** @brief Returns true, if a branch of the class-hierarchy is being created, causing all new objects to store their parents. @return The status of the class-hierarchy creation */
200            inline static bool isCreatingHierarchy() { return (hierarchyCreatingCounter_s > 0); }
201
202            /** @brief Returns the network ID to identify a class through the network. @return the network ID */
203            inline const unsigned int getNetworkID() const { return this->classID_; }
204
205            /** @brief Sets the network ID to a new value. @param id The new value */
206            void setNetworkID(unsigned int id);
207
208            void addConfigValueContainer(const std::string& varname, ConfigValueContainer* container);
209            ConfigValueContainer* getConfigValueContainer(const std::string& varname);
210            ConfigValueContainer* getLowercaseConfigValueContainer(const std::string& varname);
211
212            virtual void addXMLPortParamContainer(const std::string& paramname, XMLPortParamContainer* container) = 0;
213            virtual XMLPortParamContainer* getXMLPortParamContainer(const std::string& paramname) = 0;
214
215            virtual void addXMLPortObjectContainer(const std::string& sectionname, XMLPortObjectContainer* container) = 0;
216            virtual XMLPortObjectContainer* getXMLPortObjectContainer(const std::string& sectionname) = 0;
217
218            ConsoleCommand& addConsoleCommand(ConsoleCommand* command, bool bCreateShortcut);
219            ConsoleCommand* getConsoleCommand(const std::string& name) const;
220            ConsoleCommand* getLowercaseConsoleCommand(const std::string& name) const;
221
222        protected:
223            /** @brief Returns the map that stores all Identifiers. @return The map */
224            static std::map<std::string, Identifier*>& getIdentifierMapIntern();
225            /** @brief Returns the map that stores all Identifiers with their names in lowercase. @return The map */
226            static std::map<std::string, Identifier*>& getLowercaseIdentifierMapIntern();
227
228        private:
229            Identifier();
230            Identifier(const Identifier& identifier); // don't copy
231            virtual ~Identifier();
232            void initialize(std::set<const Identifier*>* parents);
233
234            /** @brief Returns the children of the class the Identifier belongs to. @return The list of all children */
235            inline std::set<const Identifier*>& getChildrenIntern() const { return (*this->children_); }
236            /** @brief Returns the direct children of the class the Identifier belongs to. @return The list of all direct children */
237            inline std::set<const Identifier*>& getDirectChildrenIntern() const { return (*this->directChildren_); }
238
239            /**
240                @brief Increases the hierarchyCreatingCounter_s variable, causing all new objects to store their parents.
241            */
242            inline static void startCreatingHierarchy()
243            {
244                hierarchyCreatingCounter_s++;
245                COUT(4) << "*** Identifier: Increased Hierarchy-Creating-Counter to " << hierarchyCreatingCounter_s << std::endl;
246            }
247
248            /**
249                @brief Decreases the hierarchyCreatingCounter_s variable, causing the objects to stop storing their parents.
250            */
251            inline static void stopCreatingHierarchy()
252            {
253                hierarchyCreatingCounter_s--;
254                COUT(4) << "*** Identifier: Decreased Hierarchy-Creating-Counter to " << hierarchyCreatingCounter_s << std::endl;
255            }
256
257            static Identifier* getIdentifier(std::string &name, Identifier *proposal);
258
259            std::set<const Identifier*> parents_;                          //!< The parents of the class the Identifier belongs to
260            std::set<const Identifier*>* children_;                        //!< The children of the class the Identifier belongs to
261
262            std::set<const Identifier*> directParents_;                    //!< The direct parents of the class the Identifier belongs to
263            std::set<const Identifier*>* directChildren_;                  //!< The direct children of the class the Identifier belongs to
264
265            std::string name_;                                             //!< The name of the class the Identifier belongs to
266
267            BaseFactory* factory_;                                         //!< The Factory, able to create new objects of the given class (if available)
268            bool bCreatedOneObject_;                                       //!< True if at least one object of the given type was created (used to determine the need of storing the parents)
269            static int hierarchyCreatingCounter_s;                         //!< Bigger than zero if at least one Identifier stores its parents (its an int instead of a bool to avoid conflicts with multithreading)
270            unsigned int classID_;                                         //!< The network ID to identify a class through the network
271
272            bool bHasConfigValues_;                                        //!< True if this class has at least one assigned config value
273            std::map<std::string, ConfigValueContainer*> configValues_;    //!< A map to link the string of configurable variables with their ConfigValueContainer
274            std::map<std::string, ConfigValueContainer*> configValues_LC_; //!< A map to link the string of configurable variables with their ConfigValueContainer
275
276            bool bHasConsoleCommands_;                                     //!< True if this class has at least one assigned console command
277            std::map<std::string, ConsoleCommand*> consoleCommands_;       //!< All console commands of this class
278            std::map<std::string, ConsoleCommand*> consoleCommands_LC_;    //!< All console commands of this class with their names in lowercase
279    };
280
281    _CoreExport std::ostream& operator<<(std::ostream& out, const std::set<const Identifier*>& list);
282
283
284    // ###############################
285    // ###     ClassIdentifier     ###
286    // ###############################
287    //! The ClassIdentifier is derived from Identifier and holds all class-specific functions and variables the Identifier cannot have.
288    /**
289        ClassIdentifier is a Singleton, which means that only one object of a given type T exists.
290        This makes it possible to store informations about a class, sharing them with all
291        objects of that class without defining static variables in every class.
292
293        To be really sure that not more than exactly one object exists (even with libraries),
294        ClassIdentifiers are stored in the Identifier Singleton.
295    */
296    template <class T>
297    class ClassIdentifier : public Identifier
298    {
299        public:
300            ClassIdentifier<T>* registerClass(std::set<const Identifier*>* parents, const std::string& name, bool bRootClass);
301            void addObject(T* object);
302            void setName(const std::string& name);
303            /** @brief Returns the list of all existing objects of this class. @return The list */
304            inline ObjectList<T>* getObjects() const { return this->objects_; }
305            /** @brief Returns a list of all existing objects of this class. @return The list */
306            inline ObjectList<BaseObject>* getObjectList() const { return (ObjectList<BaseObject>*)this->objects_; }
307
308            void updateConfigValues() const;
309
310            XMLPortParamContainer* getXMLPortParamContainer(const std::string& paramname);
311            void addXMLPortParamContainer(const std::string& paramname, XMLPortParamContainer* container);
312
313            XMLPortObjectContainer* getXMLPortObjectContainer(const std::string& sectionname);
314            void addXMLPortObjectContainer(const std::string& sectionname, XMLPortObjectContainer* container);
315
316            static ClassIdentifier<T> *getIdentifier();
317
318        private:
319            ClassIdentifier();
320            ClassIdentifier(const ClassIdentifier<T>& identifier) {}    // don't copy
321            ~ClassIdentifier() {}                                       // don't delete
322
323            ObjectList<T>* objects_;                                                                    //!< The ObjectList, containing all objects of type T
324            bool bSetName_;                                                                             //!< True if the name is set
325            std::map<std::string, XMLPortClassParamContainer<T>*> xmlportParamContainers_;              //!< All loadable parameters
326            std::map<std::string, XMLPortClassObjectContainer<T, class O>*> xmlportObjectContainers_;   //!< All attachable objects
327
328            static ClassIdentifier<T> *classIdentifier_s;
329    };
330
331    template <class T>
332    ClassIdentifier<T> *ClassIdentifier<T>::classIdentifier_s = 0;
333
334    /**
335        @brief Constructor: Creates the ObjectList.
336    */
337    template <class T>
338    ClassIdentifier<T>::ClassIdentifier()
339    {
340//        this->objects_ = ObjectList<T>::getList();
341        this->objects_ = new ObjectList<T>();
342        this->bSetName_ = false;
343    }
344
345    /**
346        @brief Registers a class, which means that the name and the parents get stored.
347        @param parents A list, containing the Identifiers of all parents of the class
348        @param name A string, containing exactly the name of the class
349        @param bRootClass True if the class is either an Interface or the BaseObject itself
350        @return The ClassIdentifier itself
351    */
352    template <class T>
353    ClassIdentifier<T>* ClassIdentifier<T>::registerClass(std::set<const Identifier*>* parents, const std::string& name, bool bRootClass)
354    {
355        this->setName(name);
356
357        // Check if at least one object of the given type was created
358        if (!this->bCreatedOneObject_ && Identifier::isCreatingHierarchy())
359        {
360            // If no: We have to store the informations and initialize the Identifier
361            COUT(4) << "*** ClassIdentifier: Register Class in " << name << "-Singleton -> Initialize Singleton." << std::endl;
362            if (bRootClass)
363                this->initialize(NULL); // If a class is derived from two interfaces, the second interface might think it's derived from the first because of the order of constructor-calls. Thats why we set parents to zero in that case.
364            else
365                this->initialize(parents);
366        }
367
368        return this;
369    }
370
371    /**
372        @brief Creates the only instance of this class for the template class T and retrieves a unique Identifier for the given name.
373        @return The unique Identifier
374    */
375    template <class T>
376    ClassIdentifier<T>* ClassIdentifier<T>::getIdentifier()
377    {
378        // check if the static field has already been filled
379        if (ClassIdentifier<T>::classIdentifier_s == 0)
380        {
381            // Get the name of the class
382            std::string name = typeid(T).name();
383
384            // create a new identifier anyway. Will be deleted in Identifier::getIdentifier if not used.
385            ClassIdentifier<T> *proposal = new ClassIdentifier<T>();
386
387            // Get the entry from the map
388            ClassIdentifier<T>::classIdentifier_s = (ClassIdentifier<T>*)Identifier::getIdentifier(name, proposal);
389        }
390
391        // Finally return the unique ClassIdentifier
392        return ClassIdentifier<T>::classIdentifier_s;
393    }
394
395    /**
396        @brief Sets the name of the class.
397        @param name The name
398    */
399    template <class T>
400    void ClassIdentifier<T>::setName(const std::string& name)
401    {
402        if (!this->bSetName_)
403        {
404            this->name_ = name;
405            this->bSetName_ = true;
406            Identifier::getIdentifierMapIntern()[name] = this;
407            Identifier::getLowercaseIdentifierMapIntern()[getLowercase(name)] = this;
408        }
409    }
410
411    /**
412        @brief Adds an object of the given type to the ObjectList.
413        @param object The object to add
414    */
415    template <class T>
416    void ClassIdentifier<T>::addObject(T* object)
417    {
418        COUT(5) << "*** ClassIdentifier: Added object to " << this->getName() << "-list." << std::endl;
419        object->getMetaList().add(this->objects_, this->objects_->add(object));
420    }
421
422    /**
423        @brief Updates the config-values of all existing objects of this class by calling their setConfigValues() function.
424    */
425    template <class T>
426    void ClassIdentifier<T>::updateConfigValues() const
427    {
428        for (Iterator<T> it = this->objects_->start(); it; ++it)
429            ((T*)*it)->setConfigValues();
430    }
431
432    /**
433        @brief Returns a XMLPortParamContainer that loads a parameter of this class.
434        @param paramname The name of the parameter
435        @return The container
436    */
437    template <class T>
438    XMLPortParamContainer* ClassIdentifier<T>::getXMLPortParamContainer(const std::string& paramname)
439    {
440        typename std::map<std::string, XMLPortClassParamContainer<T>*>::const_iterator it = xmlportParamContainers_.find(paramname);
441        if (it != xmlportParamContainers_.end())
442            return (XMLPortParamContainer*)((*it).second);
443        else
444            return 0;
445    }
446
447    /**
448        @brief Adds a new XMLPortParamContainer that loads a parameter of this class.
449        @param paramname The name of the parameter
450        @param container The container
451    */
452    template <class T>
453    void ClassIdentifier<T>::addXMLPortParamContainer(const std::string& paramname, XMLPortParamContainer* container)
454    {
455        this->xmlportParamContainers_[paramname] = (XMLPortClassParamContainer<T>*)container;
456    }
457
458    /**
459        @brief Returns a XMLPortObjectContainer that attaches an object to this class.
460        @param sectionname The name of the section that contains the attachable objects
461        @return The container
462    */
463    template <class T>
464    XMLPortObjectContainer* ClassIdentifier<T>::getXMLPortObjectContainer(const std::string& sectionname)
465    {
466        typename std::map<std::string, XMLPortClassObjectContainer<T, class O>*>::const_iterator it = xmlportObjectContainers_.find(sectionname);
467        if (it != xmlportObjectContainers_.end())
468            return (XMLPortObjectContainer*)((*it).second);
469        else
470            return 0;
471    }
472
473    /**
474        @brief Adds a new XMLPortObjectContainer that attaches an object to this class.
475        @param sectionname The name of the section that contains the attachable objects
476        @param container The container
477    */
478    template <class T>
479    void ClassIdentifier<T>::addXMLPortObjectContainer(const std::string& sectionname, XMLPortObjectContainer* container)
480    {
481        this->xmlportObjectContainers_[sectionname] = (XMLPortClassObjectContainer<T, class O>*)container;
482    }
483
484
485    // ###############################
486    // ###   SubclassIdentifier    ###
487    // ###############################
488    //! The SubclassIdentifier acts almost like an Identifier, but has some prerequisites.
489    /**
490        You can only assign an Identifier that belongs to a class T (or derived) to a SubclassIdentifier<T>.
491        If you assign something else, the program aborts.
492        Because we know the minimal type, a dynamic_cast is done, which makes it easier to create a new object.
493    */
494    template <class T>
495    class SubclassIdentifier
496    {
497        public:
498            /**
499                @brief Constructor: Automaticaly assigns the Identifier of the given class.
500            */
501            SubclassIdentifier()
502            {
503                this->identifier_ = ClassIdentifier<T>::getIdentifier();
504            }
505
506            /**
507                @brief Copyconstructor: Assigns the given Identifier.
508                @param identifier The Identifier
509            */
510            SubclassIdentifier(Identifier* identifier)
511            {
512                this->identifier_ = identifier;
513            }
514
515            /**
516                @brief Overloading of the = operator: assigns the identifier and checks its type.
517                @param identifier The Identifier to assign
518                @return The SubclassIdentifier itself
519            */
520            SubclassIdentifier<T>& operator=(Identifier* identifier)
521            {
522                if (!identifier->isA(ClassIdentifier<T>::getIdentifier()))
523                {
524                    COUT(1) << "An error occurred in SubclassIdentifier (Identifier.h):" << std::endl;
525                    COUT(1) << "Error: Class " << identifier->getName() << " is not a " << ClassIdentifier<T>::getIdentifier()->getName() << "!" << std::endl;
526                    COUT(1) << "Error: SubclassIdentifier<" << ClassIdentifier<T>::getIdentifier()->getName() << "> = Class(" << identifier->getName() << ") is forbidden." << std::endl;
527                    COUT(1) << "Aborting..." << std::endl;
528                    abort();
529                }
530                this->identifier_ = identifier;
531                return *this;
532            }
533
534            /**
535                @brief Overloading of the * operator: returns the assigned identifier.
536                @return The assigned identifier
537            */
538            Identifier* operator*()
539            {
540                return this->identifier_;
541            }
542
543            /**
544                @brief Overloading of the -> operator: returns the assigned identifier.
545                @return The assigned identifier
546            */
547            Identifier* operator->() const
548            {
549                return this->identifier_;
550            }
551
552            /**
553                @brief Creates a new object of the type of the assigned Identifier and dynamic_casts it to the minimal type given by T.
554                @return The new object
555            */
556            T* fabricate()
557            {
558                BaseObject* newObject = this->identifier_->fabricate();
559
560                // Check if the creation was successful
561                if (newObject)
562                {
563                    // Do a dynamic_cast, because an object of type T is much better than of type BaseObject
564                    return (T*)(newObject);
565                }
566                else
567                {
568                    // Something went terribly wrong
569                    if (this->identifier_)
570                    {
571                        COUT(1) << "An error occurred in SubclassIdentifier (Identifier.h):" << std::endl;
572                        COUT(1) << "Error: Class " << this->identifier_->getName() << " is not a " << ClassIdentifier<T>::getIdentifier()->getName() << "!" << std::endl;
573                        COUT(1) << "Error: Couldn't fabricate a new Object." << std::endl;
574                        COUT(1) << "Aborting..." << std::endl;
575                    }
576                    else
577                    {
578                        COUT(1) << "An error occurred in SubclassIdentifier (Identifier.h):" << std::endl;
579                        COUT(1) << "Error: Couldn't fabricate a new Object - Identifier is undefined." << std::endl;
580                        COUT(1) << "Aborting..." << std::endl;
581                    }
582
583                    abort();
584                }
585            }
586
587            /** @brief Returns the assigned identifier. @return The identifier */
588            inline const Identifier* getIdentifier() const
589                { return this->identifier_; }
590
591            /** @brief Returns true, if the assigned identifier is at least of the given type. @param identifier The identifier to compare with */
592            inline bool isA(const Identifier* identifier) const
593                { return this->identifier_->isA(identifier); }
594
595            /** @brief Returns true, if the assigned identifier is exactly of the given type. @param identifier The identifier to compare with */
596            inline bool isExactlyA(const Identifier* identifier) const
597                { return this->identifier_->isExactlyA(identifier); }
598
599            /** @brief Returns true, if the assigned identifier is a child of the given identifier. @param identifier The identifier to compare with */
600            inline bool isChildOf(const Identifier* identifier) const
601                { return this->identifier_->isChildOf(identifier); }
602
603            /** @brief Returns true, if the assigned identifier is a direct child of the given identifier. @param identifier The identifier to compare with */
604            inline bool isDirectChildOf(const Identifier* identifier) const
605                { return this->identifier_->isDirectChildOf(identifier); }
606
607            /** @brief Returns true, if the assigned identifier is a parent of the given identifier. @param identifier The identifier to compare with */
608            inline bool isParentOf(const Identifier* identifier) const
609                { return this->identifier_->isParentOf(identifier); }
610
611            /** @brief Returns true, if the assigned identifier is a direct parent of the given identifier. @param identifier The identifier to compare with */
612            inline bool isDirectParentOf(const Identifier* identifier) const
613                { return this->identifier_->isDirectParentOf(identifier); }
614
615        private:
616            Identifier* identifier_;            //!< The assigned identifier
617    };
618}
619
620#endif /* _Identifier_H__ */
Note: See TracBrowser for help on using the repository browser.