src/io/SectionParser.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).
 */
 
#ifndef IO_SECTIONPARSER_HPP
#define IO_SECTIONPARSER_HPP

#include <iostream>
#include <string>

#include "utils/StringTokenizer.hpp"

namespace OpenMD {
  
  class ForceField;
  
  /**
  * @class SectionParser SectionParser.hpp "io/SectionParser.hpp"
   * @todo document
   */
  class SectionParser {
  public:
    virtual ~SectionParser() {}
    void parse(std::istream& input, ForceField& ff, int lineNo);
    
    const std::string& getSectionName() const {
      return sectionName_;
    }
    virtual void validateSection() {}
  protected:
    void setSectionName(const std::string& sectionName) {
      sectionName_ = sectionName;
    }
    
  private:
    bool isEndSection(const std::string& line);
    virtual void parseLine(ForceField& ff, const std::string& line, int lineNo) = 0;

    
    std::string sectionName_;
  };


}

#endif //IO_SECTIONPARSER_HPP
Revision:	1782
Committed:	Wed Aug 22 02:28:28 2012 UTC (13 years, 2 months ago) by gezelter
File size:	3053 byte(s)
Log Message:	MERGE OpenMD development branch 1465:1781 into trunk
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* 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	246	* 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	246	* 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	1782	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	gezelter	246	*/
42
43			#ifndef IO_SECTIONPARSER_HPP
44			#define IO_SECTIONPARSER_HPP
45
46			#include <iostream>
47			#include <string>
48
49			#include "utils/StringTokenizer.hpp"
50
51	gezelter	1390	namespace OpenMD {
52	chrisfen	514
53	gezelter	507	class ForceField;
54	chrisfen	514
55	gezelter	507	/**
56	chrisfen	514	* @class SectionParser SectionParser.hpp "io/SectionParser.hpp"
57	gezelter	507	* @todo document
58			*/
59			class SectionParser {
60			public:
61			virtual ~SectionParser() {}
62			void parse(std::istream& input, ForceField& ff, int lineNo);
63	chrisfen	514
64	gezelter	507	const std::string& getSectionName() const {
65			return sectionName_;
66			}
67	tim	749	virtual void validateSection() {}
68	gezelter	507	protected:
69			void setSectionName(const std::string& sectionName) {
70			sectionName_ = sectionName;
71			}
72	chrisfen	514
73	gezelter	507	private:
74			bool isEndSection(const std::string& line);
75			virtual void parseLine(ForceField& ff, const std::string& line, int lineNo) = 0;
76	tim	749
77
78	gezelter	507	std::string sectionName_;
79			};
80	gezelter	246
81
82			}
83
84			#endif //IO_SECTIONPARSER_HPP