Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/ClassFactory.h @ 9022

Last change on this file since 9022 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 2.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    @ingroup Object Factory
32    @brief Definition and implementation of the ClassFactory class
33
34    The ClassFactory is able to create new objects of a specific class which creates objects.
35*/
36
37#ifndef _ClassFactory_H__
38#define _ClassFactory_H__
39
40#include "CorePrereqs.h"
41
42#include <string>
43
44#include "util/Output.h"
45#include "Identifier.h"
46
47namespace orxonox
48{
49    // ###########################
50    // ###       Factory       ###
51    // ###########################
52    /// Base-class of ClassFactory.
53    class _CoreExport Factory
54    {
55        public:
56            virtual ~Factory() {};
57            virtual BaseObject* fabricate(BaseObject* creator) = 0;
58    };
59
60    // ###############################
61    // ###      ClassFactory       ###
62    // ###############################
63    /// The ClassFactory is able to create new objects of a specific class.
64    template <class T>
65    class ClassFactory : public Factory
66    {
67        public:
68            /**
69                @brief Constructor: Adds the ClassFactory to the Identifier of the same type.
70                @param name The name of the class
71                @param bLoadable True if the class can be loaded through XML
72            */
73            ClassFactory(const std::string& name, bool bLoadable = true)
74            {
75                orxout(verbose, context::misc::factory) << "Create entry for " << name << " in Factory." << endl;
76                ClassIdentifier<T>::getIdentifier(name)->addFactory(this);
77                ClassIdentifier<T>::getIdentifier()->setLoadable(bLoadable);
78            }
79
80            /**
81                @brief Creates and returns a new object of class T.
82                @return The new object
83            */
84            inline BaseObject* fabricate(BaseObject* creator)
85            {
86                return static_cast<BaseObject*>(new T(creator));
87            }
88    };
89}
90
91#endif /* _ClassFactory_H__ */
Note: See TracBrowser for help on using the repository browser.