src/lattice/LatticeCreator.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.
 */
 
#ifndef LATTICE_LATTICECREATOR_HPP 
#define LATTICE_LATTICECREATOR_HPP

#include <string>

namespace oopse {

class Lattice;

/**
 * @class Lattice
 * @todo document
 */
class LatticeCreator {
    public:
        LatticeCreator(const std::string& ident) : ident_(ident) {}
        virtual ~LatticeCreator() {}
        
        const std::string& getIdent() const { return ident_; }

        virtual Lattice* create() const = 0;
            
    private:
        std::string ident_;
};

/**
 * @class LatticeBuilder
 * @todo document
 */
template<class ConcreteLattice>
class LatticeBuilder : public LatticeCreator {
    public:
        LatticeBuilder(const std::string& ident) : LatticeCreator(ident) {}
        virtual  Lattice* create() const {return new ConcreteLattice();}
};

}

#endif //USETHEFORCE_FORCEFIELDCREATOR_HPP
Revision:	2181
Committed:	Tue Apr 12 21:58:09 2005 UTC (19 years, 3 months ago) by tim
File size:	2904 byte(s)
Log Message:	refactory LatticeFactory and LatticeCreator
#	User	Rev	Content
1	gezelter	2179	/*
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	tim	2181	#ifndef LATTICE_LATTICECREATOR_HPP
43	gezelter	2179	#define LATTICE_LATTICECREATOR_HPP
44	tim	2181
45	gezelter	2179	#include <string>
46
47			namespace oopse {
48
49	tim	2181	class Lattice;
50
51			/**
52			* @class Lattice
53			* @todo document
54			*/
55			class LatticeCreator {
56			public:
57			LatticeCreator(const std::string& ident) : ident_(ident) {}
58			virtual ~LatticeCreator() {}
59
60			const std::string& getIdent() const { return ident_; }
61
62			virtual Lattice* create() const = 0;
63
64			private:
65			std::string ident_;
66	gezelter	2179	};
67
68	tim	2181	/**
69			* @class LatticeBuilder
70			* @todo document
71			*/
72			template<class ConcreteLattice>
73			class LatticeBuilder : public LatticeCreator {
74			public:
75			LatticeBuilder(const std::string& ident) : LatticeCreator(ident) {}
76			virtual Lattice* create() const {return new ConcreteLattice();}
77	gezelter	2179	};
78
79			}
80	tim	2181
81			#endif //USETHEFORCE_FORCEFIELDCREATOR_HPP