src/UseTheForce/ForceFieldFactory.hpp

/*
 * Copyright (C) 2000-2004  Object Oriented Parallel Simulation Engine (OOPSE) project
 * 
 * Contact: oopse@oopse.org
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 * All we ask is that proper credit is given for our work, which includes
 * - but is not limited to - adding the above copyright notice to the beginning
 * of your source code files, and to any copyright notice that you may distribute
 * with programs based on this work.
 * 
 * This program 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

/**
 * @file ForceFieldFactory.hpp
 * @author Teng Lin
 * @date 10/24/2004
 * @version 1.0
 */
#ifndef USETHEFORCE_FORCEFIELDFACTORY_HPP
#define USETHEFORCE_FORCEFIELDFACTORY_HPP
#include <cassert>
#include <map>
#include <string>
#include <vector>
#include <iostream>
namespace oopse {

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

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

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

        /**
         * Registers a creator with a type identifier
         * @return true if registration is succeed, otherwise return false
         * @id the identification of the concrete object
         * @creator the object responsible to create the concrete object 
         */
        bool registerForceField(ForceFieldCreator* 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 unregisterForceField(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
         */
        ForceField* createForceField(const std::string& id);

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

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

}//namespace oopse
#endif //USETHEFORCE_FORCEFIELDFACTORY_HPP
Revision:	1913
Committed:	Mon Jan 10 22:04:20 2005 UTC (19 years, 6 months ago) by tim
File size:	4108 byte(s)
Log Message:	create a register module to register force fields, integrators and minimizers
#	Content
1	/*
2	* Copyright (C) 2000-2004 Object Oriented Parallel Simulation Engine (OOPSE) project
3	*
4	* Contact: oopse@oopse.org
5	*
6	* This program is free software; you can redistribute it and/or
7	* modify it under the terms of the GNU Lesser General Public License
8	* as published by the Free Software Foundation; either version 2.1
9	* of the License, or (at your option) any later version.
10	* All we ask is that proper credit is given for our work, which includes
11	* - but is not limited to - adding the above copyright notice to the beginning
12	* of your source code files, and to any copyright notice that you may distribute
13	* with programs based on this work.
14	*
15	* This program is distributed in the hope that it will be useful,
16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18	* GNU Lesser General Public License for more details.
19	*
20	* You should have received a copy of the GNU Lesser General Public License
21	* along with this program; if not, write to the Free Software
22	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23	*
24	*/
25
26	/**
27	* @file ForceFieldFactory.hpp
28	* @author Teng Lin
29	* @date 10/24/2004
30	* @version 1.0
31	*/
32	#ifndef USETHEFORCE_FORCEFIELDFACTORY_HPP
33	#define USETHEFORCE_FORCEFIELDFACTORY_HPP
34	#include <cassert>
35	#include <map>
36	#include <string>
37	#include <vector>
38	#include <iostream>
39	namespace oopse {
40
41	//forward declaration
42	class ForceField;
43	class ForceFieldCreator;
44	/**
45	* @class ForceFieldFactory ForceFieldFactory.hpp "UseTheForce/ForceFieldFactory.hpp"
46	* Factory pattern and Singleton Pattern are used to define an interface for creating an ForceField.
47	*/
48	class ForceFieldFactory {
49	public:
50
51	typedef std::map<std::string, ForceFieldCreator*> CreatorMapType;
52	typedef std::vector<std::string> IdentVectorType;
53	typedef std::vector<std::string>::iterator IdentVectorIterator;
54
55	~ForceFieldFactory();
56
57	/**
58	* Returns an instance of ForceField factory
59	* @return an instance of ForceField factory
60	*/
61	static ForceFieldFactory* getInstance() {
62
63	if (instance_ == NULL) {
64	instance_ = new ForceFieldFactory();
65	}
66	return instance_;
67
68	}
69
70	/**
71	* Registers a creator with a type identifier
72	* @return true if registration is succeed, otherwise return false
73	* @id the identification of the concrete object
74	* @creator the object responsible to create the concrete object
75	*/
76	bool registerForceField(ForceFieldCreator* creator);
77
78	/**
79	* Unregisters the creator for the given type identifier. If the type identifier
80	* was previously registered, the function returns true.
81	* @return truethe type identifier was previously registered and the creator is removed,
82	* otherwise return false
83	* @id the identification of the concrete object
84	*/
85	bool unregisterForceField(const std::string& id);
86	/**
87	* Looks up the type identifier in the internal map. If it is found, it invokes the
88	* corresponding creator for the type identifier and returns its result.
89	* @return a pointer of the concrete object, return NULL if no creator is registed for
90	* creating this concrete object
91	* @param id the identification of the concrete object
92	*/
93	ForceField* createForceField(const std::string& id);
94
95	/**
96	* Returns all of the registed type identifiers
97	* @return all of the registed type identifiers
98	*/
99	IdentVectorType getIdents();
100
101	private:
102	ForceFieldFactory() {}
103
104	static ForceFieldFactory* instance_;
105	CreatorMapType creatorMap_;
106	};
107
108	/** write out all of the type identifiers to an output stream */
109	std::ostream& operator <<(std::ostream& o, ForceFieldFactory& factory);
110
111	}//namespace oopse
112	#endif //USETHEFORCE_FORCEFIELDFACTORY_HPP