applications/hydrodynamics/HydrodynamicsModelFactory.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 HydrodynamicsModelFactory.hpp
 * @author Teng Lin
 * @date 10/24/2004
 * @version 1.0
 */
#ifndef APPLICATION_HYDRODYNAMICS_HYDRODYNAMICSMODELFACTORY_HPP
#define APPLICATION_HYDRODYNAMICS_HYDRODYNAMICSMODELFACTORY_HPP
#include <cassert>
#include <map>
#include <string>
#include <vector>
#include <iostream>
#include "utils/any.hpp"

namespace OpenMD {

  //forward declaration
  class HydrodynamicsModel;
  class HydrodynamicsModelCreator;
  class StuntDouble;
  class SimInfo;

  /**
   * @class HydrodynamicsModelFactory HydrodynamicsModelFactory.hpp "UseTheForce/HydrodynamicsModelFactory.hpp"
   * Factory pattern and Singleton Pattern are used to define an interface for creating an HydrodynamicsModel.
   */
  class HydrodynamicsModelFactory {
  public:
                
    typedef std::map<std::string, HydrodynamicsModelCreator*> CreatorMapType;
    typedef std::vector<std::string> IdentVectorType;
    typedef std::vector<std::string>::iterator IdentVectorIterator;

    ~HydrodynamicsModelFactory();                    

    /**
     * Returns an instance of HydrodynamicsModel factory
     * @return an instance of HydrodynamicsModel factory
     */        
    static HydrodynamicsModelFactory* getInstance() {

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

    /**
     * Registers a creator with a type identifier
     * @return true if registration is successful, otherwise return false
     * @id the identification of the concrete object
     * @creator the object responsible to create the concrete object 
     */
    bool registerHydrodynamicsModel(HydrodynamicsModelCreator* 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
     * @id the identification of the concrete object
     */
    bool unregisterHydrodynamicsModel(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
     */
    HydrodynamicsModel* createHydrodynamicsModel(const std::string& id, StuntDouble* sd, SimInfo* info);

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

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

}//namespace OpenMD
#endif //INTEGRATORS_INTEGRATORFACTORY_HPP

Revision:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	5279 byte(s)
Log Message:	updated copyright notices
#	User	Rev	Content
1	tim	891	/*
2			* 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	tim	891	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	tim	891	* 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	tim	891	*/
42
43			/**
44			* @file HydrodynamicsModelFactory.hpp
45			* @author Teng Lin
46			* @date 10/24/2004
47			* @version 1.0
48			*/
49			#ifndef APPLICATION_HYDRODYNAMICS_HYDRODYNAMICSMODELFACTORY_HPP
50			#define APPLICATION_HYDRODYNAMICS_HYDRODYNAMICSMODELFACTORY_HPP
51			#include <cassert>
52			#include <map>
53			#include <string>
54			#include <vector>
55			#include <iostream>
56			#include "utils/any.hpp"
57
58	gezelter	1390	namespace OpenMD {
59	tim	891
60			//forward declaration
61			class HydrodynamicsModel;
62			class HydrodynamicsModelCreator;
63	tim	892	class StuntDouble;
64	tim	906	class SimInfo;
65	tim	891
66			/**
67			* @class HydrodynamicsModelFactory HydrodynamicsModelFactory.hpp "UseTheForce/HydrodynamicsModelFactory.hpp"
68			* Factory pattern and Singleton Pattern are used to define an interface for creating an HydrodynamicsModel.
69			*/
70			class HydrodynamicsModelFactory {
71			public:
72
73			typedef std::map<std::string, HydrodynamicsModelCreator*> CreatorMapType;
74			typedef std::vector<std::string> IdentVectorType;
75			typedef std::vector<std::string>::iterator IdentVectorIterator;
76
77			~HydrodynamicsModelFactory();
78
79			/**
80			* Returns an instance of HydrodynamicsModel factory
81			* @return an instance of HydrodynamicsModel factory
82			*/
83			static HydrodynamicsModelFactory* getInstance() {
84
85			if (instance_ == NULL) {
86			instance_ = new HydrodynamicsModelFactory();
87			}
88			return instance_;
89
90			}
91
92			/**
93			* Registers a creator with a type identifier
94			* @return true if registration is successful, otherwise return false
95			* @id the identification of the concrete object
96			* @creator the object responsible to create the concrete object
97			*/
98			bool registerHydrodynamicsModel(HydrodynamicsModelCreator* creator);
99
100			/**
101			* Unregisters the creator for the given type identifier. If the type identifier
102			* was previously registered, the function returns true.
103			* @return truethe type identifier was previously registered and the creator is removed,
104			* otherwise return false
105			* @id the identification of the concrete object
106			*/
107			bool unregisterHydrodynamicsModel(const std::string& id);
108			/**
109			* Looks up the type identifier in the internal map. If it is found, it invokes the
110			* corresponding creator for the type identifier and returns its result.
111			* @return a pointer of the concrete object, return NULL if no creator is registed for
112			* creating this concrete object
113			* @param id the identification of the concrete object
114			*/
115	tim	906	HydrodynamicsModel* createHydrodynamicsModel(const std::string& id, StuntDouble* sd, SimInfo* info);
116	tim	891
117			/**
118			* Returns all of the registed type identifiers
119			* @return all of the registed type identifiers
120			*/
121			IdentVectorType getIdents();
122
123			private:
124			HydrodynamicsModelFactory() {}
125			static HydrodynamicsModelFactory* instance_;
126			CreatorMapType creatorMap_;
127			};
128
129			/** write out all of the type identifiers to an output stream */
130			std::ostream& operator <<(std::ostream& o, HydrodynamicsModelFactory& factory);
131
132	gezelter	1390	}//namespace OpenMD
133	tim	891	#endif //INTEGRATORS_INTEGRATORFACTORY_HPP
134