src/io/StatWriter.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 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:	1846
Committed:	Sat Dec 4 00:01:32 2004 UTC (20 years, 10 months ago) by tim
File size:	2335 byte(s)
Log Message:	Dump2Xyz is also working, energy of NVE is not conserved
#	User	Rev	Content
1	tim	1724	/*
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 StatWriter.hpp
28			* @author tlin
29			* @date 11/08/2004
30			* @time 10:03am
31			* @version 1.0
32			*/
33
34
35			#ifndef IO_STATWRITER_HPP
36			#define IO_STATWRITER_HPP
37	tim	1808	#include <bitset>
38			#include <fstream>
39			#include <iostream>
40	tim	1724	#include <string.h>
41
42			#include "brains/Stats.hpp"
43
44			namespace oopse {
45
46	tim	1808	typedef std::bitset<Stats::ENDINDEX-Stats::BEGININDEX> StatsBitSet;
47	tim	1724
48			/**
49			* DefaultStatsBitSet includes
50	tim	1727	* StatsIndex::TIME
51			* StatsIndex::TOTAL_ENERGY
52			* StatsIndex::POTENTIAL_ENERGY
53			* StatsIndex::KINETIC_ENERGY
54	tim	1724	* StatsIndex::TEMPERATURE
55			* StatsIndex::PRESSURE
56	tim	1727	* StatsIndex::CONSERVED_QUANTITY
57	tim	1724	*/
58	tim	1846	const StatsBitSet DefaultStatsBitSet(255ul);
59	tim	1724
60
61			/**
62			* @class StatWriter StatWriter.hpp "io/StatWriter.hpp"
63			* @brief A configurable Statistics Writer
64			*/
65			class StatWriter {
66			public:
67	tim	1725	StatWriter(const std::string& filename, const StatsBitSet& mask = DefaultStatsBitSet);
68	tim	1724	~StatWriter();
69
70	tim	1819	void writeStat(const Stats& s);
71	tim	1724
72			StatsBitSet getMask() {
73			return mask_;
74			}
75
76			private:
77	tim	1846
78			void writeTitle();
79	tim	1724
80	tim	1725	std::ofstream statfile_;
81	tim	1724	StatsBitSet mask_;
82
83			};
84
85			}
86			#endif //IO_STATWRITER_HPP