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