source: src/Potentials/PotentialFactory.hpp@ a0d8aa

/*
 * PotentialFactory.hpp
 *
 *  Created on: 30.11.2012
 *      Author: heber
 */

#ifndef POTENTIALFACTORY_HPP_
#define POTENTIALFACTORY_HPP_

// include config.h
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <string>
#include <iosfwd>

#include "CodePatterns/Singleton.hpp"

#include "Potentials/EmpiricalPotential.hpp"
#include "Potentials/Specifics/PotentialTypes.hpp"
#include "Potentials/StreamFactory_EmpiricalPotential.hpp"

/** Class that creates instances of potentials.
 *
 * This is a factory pattern.
 *
 */
class PotentialFactory :
    public Singleton<PotentialFactory>,
    public StreamFactory<EmpiricalPotential>
{
  //!> make Singleton template friend
  friend class Singleton<PotentialFactory>;

protected:

  /** Returns a default potential to which only we have access.
   *
   */
  EmpiricalPotential* getDefaultPotential(const std::string &_name) const;

public:

  /** Returns a default potential to which only we have access.
   *
   */
  EmpiricalPotential const * const getDefaultPotential(const enum PotentialTypes &_type) const;


  /** Creates an instance of the requested potential.
   *
   * \param potentialtype key of potential to create
   * \param charges charges for which the potential is (to be) fitted
   */
  EmpiricalPotential *createInstance(
      const std::string &potentialtype,
      const SerializablePotential::ParticleTypes_t &charges) const;

  /** Creates an instance of the requested potential.
   *
   * \param potentialtype key of potential to create
   * \param charges charges for which the potential is (to be) fitted
   */
  EmpiricalPotential *createInstance(
      const std::string &potentialtype,
      const SerializablePotential::ParticleTypes_t &charges,
                        const FunctionModel::parameters_t &params) const;

  /** Returns the number of particle types for the given potential.
   *
   * \param _name name of the potential
   * \return number of particle types needed by the potential, 0 if potential unknown
   */
  unsigned int getPotentialsParticleTypeNumber(const std::string &_name) const;

  //!> typedef for map to lookup type for a given name
  typedef std::map< std::string, enum PotentialTypes > NameToType_t;

  //!> map for looking up type to a given name
  static NameToType_t NameToType;

  //!> typedef for map to lookup name for a given type
  typedef std::map< enum PotentialTypes,std::string > TypeToName_t;

  //!> map for looking up type to a given name
  static TypeToName_t TypeToName;

  static enum PotentialTypes getTypeForName(const std::string &_name);

  static const std::string & getNameForType(enum PotentialTypes _type);

private:
  PotentialFactory() {}
  ~PotentialFactory() {}
};

#endif /* POTENTIALFACTORY_HPP_ */