Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/core3/src/core/Identifier.h @ 1592

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