src/lattice/LatticeFactory.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
/**
 * @file LatticeFactory.hpp
 * @author Teng Lin
 * @date 10/24/2004
 * @version 1.0
 */
#ifndef LATTICE_LATTICEFACTORY_HPP
#define LATTICE_LATTICEFACTORY_HPP
#include <cassert>
#include <map>
#include <string>
#include <vector>
#include <iostream>
namespace OpenMD {

  //forward declaration
  class Lattice;
  class LatticeCreator;
  /**
   * @class LatticeFactory
   * Factory pattern and Singleton Pattern are used to define an interface for creating an Lattice.
   */
  class LatticeFactory {
  public:
                
    typedef std::map<std::string, LatticeCreator*> CreatorMapType;
    typedef std::vector<std::string> IdentVectorType;
    typedef std::vector<std::string>::iterator IdentVectorIterator;

    ~LatticeFactory();
                    
    /**
     * Returns an instance of Lattice factory
     * @return an instance of Lattice factory
     */        
    static LatticeFactory* getInstance() {

      if (instance_ == NULL) {
        instance_ = new LatticeFactory();
      }
      return instance_;
            
    }

    /**
     * Registers a creator with a type identifier
     * @return true if registration is succeed, otherwise return false
     * @param creator the object responsible to create the concrete object 
     */
    bool registerLattice(LatticeCreator* creator);

    /**
     * Unregisters the creator for the given type identifier. If the type identifier 
     * was previously registered, the function returns true.
     * @return truethe type identifier was previously registered and the creator is removed,
     * otherwise return false
     * @param id the identification of the concrete object
     */
    bool unregisterLattice(const std::string& id);
    /**
     * Looks up the type identifier in the internal map. If it is found, it invokes the
     * corresponding creator for the type identifier and returns its result. 
     * @return a pointer of the concrete object, return NULL if no creator is registed for 
     * creating this concrete object
     * @param id the identification of the concrete object
     */
    Lattice* createLattice(const std::string& id);

    /** 
     *  Returns all of the registed  type identifiers
     * @return all of the registed  type identifiers
     */
    IdentVectorType getIdents();
        
  private:
    LatticeFactory() {}
        
    static LatticeFactory* instance_;
    CreatorMapType creatorMap_;
  };

  /** write out all of the type identifiers to an output stream */
  std::ostream& operator <<(std::ostream& o, LatticeFactory& factory);

}//namespace OpenMD
#endif //USETHEFORCE_FORCEFIELDFACTORY_HPP
Revision:	1808
Committed:	Mon Oct 22 20:42:10 2012 UTC (12 years, 6 months ago) by gezelter
File size:	4794 byte(s)
Log Message:	A bug fix in the electric field for the new electrostatic code. Also comment fixes for Doxygen
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	482	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3			*
4			* The University of Notre Dame grants you ("Licensee") a
5			* non-exclusive, royalty free, license to use, modify and
6			* redistribute this software in source and binary code form, provided
7			* that the following conditions are met:
8			*
9	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	gezelter	482	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	gezelter	482	* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
28			* arising out of the use of or inability to use software, even if the
29			* University of Notre Dame has been advised of the possibility of
30			* such damages.
31	gezelter	1390	*
32			* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33			* research, please cite the appropriate papers when you publish your
34			* work. Good starting points are:
35			*
36			* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37			* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38			* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	gezelter	482	*/
42
43	tim	484	/**
44			* @file LatticeFactory.hpp
45			* @author Teng Lin
46			* @date 10/24/2004
47			* @version 1.0
48			*/
49	gezelter	482	#ifndef LATTICE_LATTICEFACTORY_HPP
50			#define LATTICE_LATTICEFACTORY_HPP
51	tim	484	#include <cassert>
52	gezelter	482	#include <map>
53			#include <string>
54	tim	484	#include <vector>
55			#include <iostream>
56	gezelter	1390	namespace OpenMD {
57	gezelter	482
58	gezelter	507	//forward declaration
59			class Lattice;
60			class LatticeCreator;
61			/**
62	gezelter	1725	* @class LatticeFactory
63	gezelter	507	* Factory pattern and Singleton Pattern are used to define an interface for creating an Lattice.
64			*/
65			class LatticeFactory {
66			public:
67	tim	484
68	gezelter	507	typedef std::map<std::string, LatticeCreator*> CreatorMapType;
69			typedef std::vector<std::string> IdentVectorType;
70			typedef std::vector<std::string>::iterator IdentVectorIterator;
71	gezelter	482
72	gezelter	507	~LatticeFactory();
73	tim	484
74	gezelter	507	/**
75			* Returns an instance of Lattice factory
76			* @return an instance of Lattice factory
77			*/
78			static LatticeFactory* getInstance() {
79	gezelter	482
80	gezelter	507	if (instance_ == NULL) {
81			instance_ = new LatticeFactory();
82			}
83			return instance_;
84	tim	484
85	gezelter	507	}
86	gezelter	482
87	gezelter	507	/**
88			* Registers a creator with a type identifier
89			* @return true if registration is succeed, otherwise return false
90	gezelter	1808	* @param creator the object responsible to create the concrete object
91	gezelter	507	*/
92			bool registerLattice(LatticeCreator* creator);
93	gezelter	482
94	gezelter	507	/**
95			* Unregisters the creator for the given type identifier. If the type identifier
96			* was previously registered, the function returns true.
97			* @return truethe type identifier was previously registered and the creator is removed,
98			* otherwise return false
99	gezelter	1808	* @param id the identification of the concrete object
100	gezelter	507	*/
101			bool unregisterLattice(const std::string& id);
102			/**
103			* Looks up the type identifier in the internal map. If it is found, it invokes the
104			* corresponding creator for the type identifier and returns its result.
105			* @return a pointer of the concrete object, return NULL if no creator is registed for
106			* creating this concrete object
107			* @param id the identification of the concrete object
108			*/
109			Lattice* createLattice(const std::string& id);
110	gezelter	482
111	gezelter	507	/**
112			* Returns all of the registed type identifiers
113			* @return all of the registed type identifiers
114			*/
115			IdentVectorType getIdents();
116	tim	484
117	gezelter	507	private:
118			LatticeFactory() {}
119	tim	484
120	gezelter	507	static LatticeFactory* instance_;
121			CreatorMapType creatorMap_;
122			};
123	gezelter	482
124	gezelter	507	/** write out all of the type identifiers to an output stream */
125			std::ostream& operator <<(std::ostream& o, LatticeFactory& factory);
126	gezelter	482
127	gezelter	1390	}//namespace OpenMD
128	tim	484	#endif //USETHEFORCE_FORCEFIELDFACTORY_HPP