basicdevicefactory.h

Go to the documentation of this file.

/***************************************************************************
                          basicdevicefactory.h  -  description
                             -------------------
    begin                : Tue May 14 2002
    copyright            : (C) 2002 by Peter Haase
    email                : mail@p-haase.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef BASIC_DEVICE_FACTORY_HEADER
#define BASIC_DEVICE_FACTORY_HEADER

#include <string>
#include <iosfwd>
#include <map>
#include <simthetic/propertylist.h>

namespace simth
{

class Device;
class DeviceSystemIntf;

class DeviceFactory
{
  public:
    DeviceFactory();
    virtual ~DeviceFactory() = 0;

    virtual Device* createDevice(const std::string& fileName, 
                 DeviceSystemIntf* sysPtr,
                                 int ID, 
                 const std::string blockQualifier = "") = 0;

    // The following are all quite new (Feb 2004)

    typedef simth::Device *(*FactoryFunc)(int id, 
                      simth::DeviceSystemIntf* sysPtr,
                      const simth::PropertyList& pl, 
                      const std::string& cpptype);

    typedef std::map<std::string, FactoryFunc> FactoryMap;

    virtual FactoryMap allDevices();

    void addFunction(const std::string& cppname, FactoryFunc func);

  private:
    // Data store for ethe support mechanism for easy registering of
    // factory functions.
    FactoryMap _fm;
};

template<class T>
static simth::Device* factory_function(int ID, 
                       simth::DeviceSystemIntf* sysPtr,
                       const simth::PropertyList& pl, 
                       const std::string& /*cpptype*/)
{
   return new T(ID, sysPtr, pl);
}

 std::ostream& operator<<(std::ostream&os, 
              const DeviceFactory::FactoryMap& fm);

} // namespace

#endif // BASIC_DEVICE_FACTORY_HEADER

---