src/io/DumpReader.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 DumpReader.hpp
 * @author tlin
 * @date 11/15/2004
 * @time 09:25am
 * @version 2.0
 */

#ifndef IO_DUMPREADER_HPP
#define IO_DUMPREADER_HPP

#include <cstdio>
#include <string>
#include "brains/SimInfo.hpp"
#include "primitives/StuntDouble.hpp"
namespace oopse {

  /**
   * @class DumpReader DumpReader.hpp "io/DumpReader.hpp"
   * @todo get rid of more junk code from DumpReader
   */
  class DumpReader {
  public:

    DumpReader(SimInfo* info, const std::string & filename);
    //DumpReader(SimInfo * info, istream & is);

    ~DumpReader();

    /** Returns the number of frames in the dump file*/
    int getNFrames();

        
    void readFrame(int whichFrame);

  private:

    void scanFile();

    void readSet(int whichFrame);

    void parseDumpLine(char *line, StuntDouble* integrableObject);

    void parseCommentLine(char* line, Snapshot* s);


#ifdef IS_MPI

    void anonymousNodeDie(void);
    void nodeZeroError(void);

#endif                
    // the maximum length of a typical MPI package is 15k
    const static int maxBufferSize = 8192;
        
    SimInfo* info_;

    std::string filename_;
    bool isScanned_;

    int nframes_;

    FILE* inFile_;
    std::vector<fpos_t*> framePos_;

    bool needPos_;
    bool needVel_;
    bool needQuaternion_;
    bool needAngMom_;
  };

}      //end namespace oopse

#endif //IO_DUMPREADER_HPP
Revision:	2204
Committed:	Fri Apr 15 22:04:00 2005 UTC (19 years, 3 months ago) by gezelter
File size:	3461 byte(s)
Log Message:	xemacs has been drafted to perform our indentation services
#	User	Rev	Content
1	gezelter	2204	/*
2	gezelter	1930	* 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	gezelter	2204	/**
43			* @file DumpReader.hpp
44			* @author tlin
45			* @date 11/15/2004
46			* @time 09:25am
47			* @version 2.0
48			*/
49	gezelter	1930
50			#ifndef IO_DUMPREADER_HPP
51			#define IO_DUMPREADER_HPP
52
53			#include <cstdio>
54			#include <string>
55			#include "brains/SimInfo.hpp"
56			#include "primitives/StuntDouble.hpp"
57			namespace oopse {
58
59	gezelter	2204	/**
60			* @class DumpReader DumpReader.hpp "io/DumpReader.hpp"
61			* @todo get rid of more junk code from DumpReader
62			*/
63			class DumpReader {
64			public:
65	gezelter	1930
66	gezelter	2204	DumpReader(SimInfo* info, const std::string & filename);
67			//DumpReader(SimInfo * info, istream & is);
68	gezelter	1930
69	gezelter	2204	~DumpReader();
70	gezelter	1930
71	gezelter	2204	/** Returns the number of frames in the dump file*/
72			int getNFrames();
73	gezelter	1930
74
75	gezelter	2204	void readFrame(int whichFrame);
76	gezelter	1930
77	gezelter	2204	private:
78	gezelter	1930
79	gezelter	2204	void scanFile();
80	gezelter	1930
81	gezelter	2204	void readSet(int whichFrame);
82	gezelter	1930
83	gezelter	2204	void parseDumpLine(char line, StuntDouble integrableObject);
84	gezelter	1930
85	gezelter	2204	void parseCommentLine(char* line, Snapshot* s);
86	gezelter	1930
87
88			#ifdef IS_MPI
89
90	gezelter	2204	void anonymousNodeDie(void);
91			void nodeZeroError(void);
92	gezelter	1930
93			#endif
94	gezelter	2204	// the maximum length of a typical MPI package is 15k
95			const static int maxBufferSize = 8192;
96	gezelter	1930
97	gezelter	2204	SimInfo* info_;
98	gezelter	1930
99	gezelter	2204	std::string filename_;
100			bool isScanned_;
101	gezelter	1930
102	gezelter	2204	int nframes_;
103	gezelter	1930
104	gezelter	2204	FILE* inFile_;
105			std::vector<fpos_t*> framePos_;
106	tim	2002
107	gezelter	2204	bool needPos_;
108			bool needVel_;
109			bool needQuaternion_;
110			bool needAngMom_;
111			};
112	gezelter	1930
113			} //end namespace oopse
114
115			#endif //IO_DUMPREADER_HPP