Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/miniprojects/src/core/Factory.h @ 2852

Last change on this file since 2852 was 2710, checked in by rgrieder, 16 years ago

Merged buildsystem3 containing buildsystem2 containing Adi's buildsystem branch back to the trunk.
Please update the media directory if you were not using buildsystem3 before.

  • Property svn:eol-style set to native
File size: 3.8 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @brief Definition of the Factory and the BaseFactory class.
32
33    The Factory is a singleton, containing two maps to map either the name or the network ID
34    of a class with the corresponding Identifier.
35
36    Usage:
37    ID(classname) or ID(networkID) returns the corresponding Identifier.
38
39
40    BaseObject is the parent of ClassFactory which is defined in ClassFactory.h.
41    It can't be defined in ClassFactory.h, because of circular dependencies.
42*/
43
44#ifndef _Factory_H__
45#define _Factory_H__
46
47#include "CorePrereqs.h"
48
49#include <map>
50#include <string>
51
52namespace orxonox
53{
54    // ###############################
55    // ###         Factory         ###
56    // ###############################
57    //! The Factory is used to map the name or the network ID of a class with its Identifier.
58    class _CoreExport Factory
59    {
60        public:
61            static Identifier* getIdentifier(const std::string& name);
62            static Identifier* getIdentifier(const uint32_t id);
63            static void add(const std::string& name, Identifier* identifier);
64            static void changeNetworkID(Identifier* identifier, const uint32_t oldID, const uint32_t newID);
65            static void createClassHierarchy();
66
67            static Factory* getFactoryPointer();    // avoid overriding order problem in the static intialisation process
68
69            /** @brief Returns the factory-map. */
70            static const std::map<std::string, Identifier*>& getFacbtoryMap()
71                { return Factory::getFactoryPointer()->identifierStringMap_; }
72            /** @brief Returns the begin-iterator of the factory-map. */
73            static std::map<std::string, Identifier*>::const_iterator getFactoryMapBegin()
74                { return Factory::getFactoryPointer()->identifierStringMap_.begin(); }
75            /** @brief Returns the end-iterator of the factory-map. */
76            static std::map<std::string, Identifier*>::const_iterator getFactoryMapEnd()
77                { return Factory::getFactoryPointer()->identifierStringMap_.end(); }
78
79        private:
80            Factory() {}                            // don't create
81            Factory(const Factory& factory);        // don't copy
82            ~Factory() {}                           // don't delete
83
84            std::map<std::string, Identifier*> identifierStringMap_;            //!< The map, mapping the name with the Identifier
85            std::map<uint32_t, Identifier*> identifierNetworkIDMap_;        //!< The map, mapping the network ID with the Identifier
86    };
87
88    // ###############################
89    // ###       BaseFactory       ###
90    // ###############################
91    //! Base-class of ClassFactory. Has to be defined separate because of circular dependencies.
92    class _CoreExport BaseFactory
93    {
94        public:
95            virtual BaseObject* fabricate(BaseObject* creator) = 0;
96            virtual ~BaseFactory() {};
97    };
98}
99
100#endif /* _Factory_H__ */
Note: See TracBrowser for help on using the repository browser.