generic_factory.h

Go to the documentation of this file.

/*
 *  generic_factory.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST 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.
 *
 *  NEST 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 NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef GENERIC_FACTORY_H
#define GENERIC_FACTORY_H
 
// C++ includes:
#include <map>
 
// Includes from nestkernel:
#include "generic_factory.h"
#include "nest_types.h"
 
// Includes from nestutil:
#include "dictionary.h"
 
 
namespace nest
{
class AbstractGeneric;
 
template < class BaseT >
class GenericFactory
{
public:
  typedef BaseT* ( *CreatorFunction )( const Dictionary& d );
  typedef std::map< std::string, CreatorFunction > AssocMap;
 
  BaseT* create( const std::string& name, const Dictionary& d ) const;
 
  template < class T >
  bool register_subtype( const std::string& name );
 
  bool register_subtype( const std::string& name, CreatorFunction creator );
 
private:
  template < class T >
  static BaseT* new_from_dict_( const Dictionary& d );
 
  AssocMap associations_;
};
 
template < class BaseT >
inline BaseT*
GenericFactory< BaseT >::create( const std::string& name, const Dictionary& d ) const
{
  typename AssocMap::const_iterator i = associations_.find( name );
  if ( i != associations_.end() )
  {
    return ( i->second )( d );
  }
  throw UndefinedName( name );
}
 
template < class BaseT >
template < class T >
inline bool
GenericFactory< BaseT >::register_subtype( const std::string& name )
{
  return register_subtype( name, new_from_dict_< T > );
}
 
template < class BaseT >
inline bool
GenericFactory< BaseT >::register_subtype( const std::string& name, CreatorFunction creator )
{
  return associations_.insert( std::pair< std::string, CreatorFunction >( name, creator ) ).second;
}
 
template < class BaseT >
template < class T >
BaseT*
GenericFactory< BaseT >::new_from_dict_( const Dictionary& d )
{
  return new T( d );
}
 
}  // namespace nest
 
#endif