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