src/io/StatWriter.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 StatWriter.hpp
  * @author tlin
  * @date 11/08/2004
  * @time 10:03am
  * @version 1.0
  */


#ifndef IO_STATWRITER_HPP
#define IO_STATWRITER_HPP
#include <bitset>
#include <fstream>
#include <iostream>
#include <string.h>

#include "brains/Stats.hpp"

namespace oopse {

typedef std::bitset<Stats::ENDINDEX-Stats::BEGININDEX> StatsBitSet;

/**
 * DefaultStatsBitSet includes 
 *    StatsIndex::TIME
 *    StatsIndex::TOTAL_ENERGY
 *    StatsIndex::POTENTIAL_ENERGY
 *    StatsIndex::KINETIC_ENERGY
 *    StatsIndex::TEMPERATURE
 *    StatsIndex::PRESSURE
 *    StatsIndex::CONSERVED_QUANTITY
 */
const StatsBitSet DefaultStatsBitSet(255ul);


/**
 * @class StatWriter StatWriter.hpp "io/StatWriter.hpp"
 * @brief A configurable Statistics Writer
 */
class StatWriter {
    public:
        StatWriter(const std::string& filename, const StatsBitSet& mask = DefaultStatsBitSet);
        ~StatWriter();

        void writeStat(const Stats& s);

        StatsBitSet getMask() {
            return mask_;
        }
        
    private:

        void writeTitle();
        
        std::ofstream statfile_;
        StatsBitSet mask_;
        
};

}
#endif //IO_STATWRITER_HPP
Revision:	1927
Committed:	Wed Jan 12 17:14:35 2005 UTC (20 years, 6 months ago) by tim
File size:	3266 byte(s)
Log Message:	change license
#	User	Rev	Content
1	tim	1927	/*
2			* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	tim	1724	*
4	tim	1927	* 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	tim	1724	*/
41
42	tim	1927
43	tim	1724	/**
44			* @file StatWriter.hpp
45			* @author tlin
46			* @date 11/08/2004
47			* @time 10:03am
48			* @version 1.0
49			*/
50
51
52			#ifndef IO_STATWRITER_HPP
53			#define IO_STATWRITER_HPP
54	tim	1808	#include <bitset>
55			#include <fstream>
56			#include <iostream>
57	tim	1724	#include <string.h>
58
59			#include "brains/Stats.hpp"
60
61			namespace oopse {
62
63	tim	1808	typedef std::bitset<Stats::ENDINDEX-Stats::BEGININDEX> StatsBitSet;
64	tim	1724
65			/**
66			* DefaultStatsBitSet includes
67	tim	1727	* StatsIndex::TIME
68			* StatsIndex::TOTAL_ENERGY
69			* StatsIndex::POTENTIAL_ENERGY
70			* StatsIndex::KINETIC_ENERGY
71	tim	1724	* StatsIndex::TEMPERATURE
72			* StatsIndex::PRESSURE
73	tim	1727	* StatsIndex::CONSERVED_QUANTITY
74	tim	1724	*/
75	tim	1846	const StatsBitSet DefaultStatsBitSet(255ul);
76	tim	1724
77
78			/**
79			* @class StatWriter StatWriter.hpp "io/StatWriter.hpp"
80			* @brief A configurable Statistics Writer
81			*/
82			class StatWriter {
83			public:
84	tim	1725	StatWriter(const std::string& filename, const StatsBitSet& mask = DefaultStatsBitSet);
85	tim	1724	~StatWriter();
86
87	tim	1819	void writeStat(const Stats& s);
88	tim	1724
89			StatsBitSet getMask() {
90			return mask_;
91			}
92
93			private:
94	tim	1846
95			void writeTitle();
96	tim	1724
97	tim	1725	std::ofstream statfile_;
98	tim	1724	StatsBitSet mask_;
99
100			};
101
102			}
103			#endif //IO_STATWRITER_HPP