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

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

/**
    @file
    @ingroup Object Factory
    @brief Definition and implementation of the ClassFactory class

    The ClassFactory is able to create new objects of a specific class which creates objects.
*/

#ifndef _ClassFactory_H__
#define _ClassFactory_H__

#include "CorePrereqs.h"

#include <string>

#include "util/Output.h"
#include "Identifier.h"

namespace orxonox
{
    // ###########################
    // ###       Factory       ###
    // ###########################
    /// Base-class of ClassFactory.
    class _CoreExport Factory
    {
        public:
            virtual ~Factory() {};
            virtual BaseObject* fabricate(BaseObject* creator) = 0;
    };

    // ###############################
    // ###      ClassFactory       ###
    // ###############################
    /// The ClassFactory is able to create new objects of a specific class.
    template <class T>
    class ClassFactory : public Factory
    {
        public:
            /**
                @brief Constructor: Adds the ClassFactory to the Identifier of the same type.
                @param name The name of the class
                @param bLoadable True if the class can be loaded through XML
            */
            ClassFactory(const std::string& name, bool bLoadable = true)
            {
                orxout(verbose, context::misc::factory) << "Create entry for " << name << " in Factory." << endl;
                ClassIdentifier<T>::getIdentifier(name)->addFactory(this);
                ClassIdentifier<T>::getIdentifier()->setLoadable(bLoadable);
            }

            /**
                @brief Creates and returns a new object of class T.
                @return The new object
            */
            inline BaseObject* fabricate(BaseObject* creator)
            {
                return static_cast<BaseObject*>(new T(creator));
            }
    };
}

#endif /* _ClassFactory_H__ */