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. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. 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.
 */
 
/**
 * @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 oopse {

  //forward declaration
  class HydrodynamicsModel;
  class HydrodynamicsModelCreator;
  class Molecule;
  typedef std::map<std::string, boost::any> DynamicProperty;  

  /**
   * @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, Molecule* mol, const DynamicProperty& param);

    /** 
     *  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 oopse
#endif //INTEGRATORS_INTEGRATORFACTORY_HPP

Revision:	891
Committed:	Wed Feb 22 20:35:16 2006 UTC (19 years, 2 months ago) by tim
Original Path:	*trunk/src/applications/hydrodynamics/HydrodynamicsModelFactory.hpp*
File size:	5226 byte(s)
Log Message:	Adding Hydrodynamics Module
#	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			* 1. Acknowledgement of the program authors must be made in any
10			* publication of scientific results based in part on use of the
11			* program. An acceptable form of acknowledgement is citation of
12			* the article in which the program was described (Matthew
13			* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14			* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15			* Parallel Simulation Engine for Molecular Dynamics,"
16			* J. Comput. Chem. 26, pp. 252-271 (2005))
17			*
18			* 2. Redistributions of source code must retain the above copyright
19			* notice, this list of conditions and the following disclaimer.
20			*
21			* 3. Redistributions in binary form must reproduce the above copyright
22			* notice, this list of conditions and the following disclaimer in the
23			* documentation and/or other materials provided with the
24			* distribution.
25			*
26			* This software is provided "AS IS," without a warranty of any
27			* kind. All express or implied conditions, representations and
28			* warranties, including any implied warranty of merchantability,
29			* fitness for a particular purpose or non-infringement, are hereby
30			* excluded. The University of Notre Dame and its licensors shall not
31			* be liable for any damages suffered by licensee as a result of
32			* using, modifying or distributing the software or its
33			* derivatives. In no event will the University of Notre Dame or its
34			* licensors be liable for any lost revenue, profit or data, or for
35			* direct, indirect, special, consequential, incidental or punitive
36			* damages, however caused and regardless of the theory of liability,
37			* arising out of the use of or inability to use software, even if the
38			* University of Notre Dame has been advised of the possibility of
39			* such damages.
40			*/
41
42			/**
43			* @file HydrodynamicsModelFactory.hpp
44			* @author Teng Lin
45			* @date 10/24/2004
46			* @version 1.0
47			*/
48			#ifndef APPLICATION_HYDRODYNAMICS_HYDRODYNAMICSMODELFACTORY_HPP
49			#define APPLICATION_HYDRODYNAMICS_HYDRODYNAMICSMODELFACTORY_HPP
50			#include <cassert>
51			#include <map>
52			#include <string>
53			#include <vector>
54			#include <iostream>
55			#include "utils/any.hpp"
56
57			namespace oopse {
58
59			//forward declaration
60			class HydrodynamicsModel;
61			class HydrodynamicsModelCreator;
62			class Molecule;
63			typedef std::map<std::string, boost::any> DynamicProperty;
64
65			/**
66			* @class HydrodynamicsModelFactory HydrodynamicsModelFactory.hpp "UseTheForce/HydrodynamicsModelFactory.hpp"
67			* Factory pattern and Singleton Pattern are used to define an interface for creating an HydrodynamicsModel.
68			*/
69			class HydrodynamicsModelFactory {
70			public:
71
72			typedef std::map<std::string, HydrodynamicsModelCreator*> CreatorMapType;
73			typedef std::vector<std::string> IdentVectorType;
74			typedef std::vector<std::string>::iterator IdentVectorIterator;
75
76			~HydrodynamicsModelFactory();
77
78			/**
79			* Returns an instance of HydrodynamicsModel factory
80			* @return an instance of HydrodynamicsModel factory
81			*/
82			static HydrodynamicsModelFactory* getInstance() {
83
84			if (instance_ == NULL) {
85			instance_ = new HydrodynamicsModelFactory();
86			}
87			return instance_;
88
89			}
90
91			/**
92			* Registers a creator with a type identifier
93			* @return true if registration is successful, otherwise return false
94			* @id the identification of the concrete object
95			* @creator the object responsible to create the concrete object
96			*/
97			bool registerHydrodynamicsModel(HydrodynamicsModelCreator* creator);
98
99			/**
100			* Unregisters the creator for the given type identifier. If the type identifier
101			* was previously registered, the function returns true.
102			* @return truethe type identifier was previously registered and the creator is removed,
103			* otherwise return false
104			* @id the identification of the concrete object
105			*/
106			bool unregisterHydrodynamicsModel(const std::string& id);
107			/**
108			* Looks up the type identifier in the internal map. If it is found, it invokes the
109			* corresponding creator for the type identifier and returns its result.
110			* @return a pointer of the concrete object, return NULL if no creator is registed for
111			* creating this concrete object
112			* @param id the identification of the concrete object
113			*/
114			HydrodynamicsModel* createHydrodynamicsModel(const std::string& id, Molecule* mol, const DynamicProperty& param);
115
116			/**
117			* Returns all of the registed type identifiers
118			* @return all of the registed type identifiers
119			*/
120			IdentVectorType getIdents();
121
122			private:
123			HydrodynamicsModelFactory() {}
124			static HydrodynamicsModelFactory* instance_;
125			CreatorMapType creatorMap_;
126			};
127
128			/** write out all of the type identifiers to an output stream */
129			std::ostream& operator <<(std::ostream& o, HydrodynamicsModelFactory& factory);
130
131			}//namespace oopse
132			#endif //INTEGRATORS_INTEGRATORFACTORY_HPP
133