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 <string.h>
#include <iostream>
#include <fstream>

#include "brains/Stats.hpp"

namespace oopse {

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

/**
 * DefaultStatsBitSet includes 
 *    StatsIndex::TOTALENERGY
 *    StatsIndex::TOTALPOTENTIAL
 *    StatsIndex::TEMPERATURE
 *    StatsIndex::PRESSURE
 *    StatsIndex::CONSERVEQUAN
 *    StatsIndex::TOTALENERGY
 */
const StatsBitSet DefaultStatsBitSet(63ul);


/**
 * @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 writeTitle();
        void writeStat(Snapshot* s);

        StatsBitSet getMask() {
            return mask_;
        }
        
    private:
        
        std::ofstream statfile_;
        StatsBitSet mask_;
        
};

}
#endif //IO_STATWRITER_HPP
Revision:	1725
Committed:	Wed Nov 10 22:01:06 2004 UTC (19 years, 8 months ago) by tim
File size:	2277 byte(s)
Log Message:	another painful day (1) SimCreator, SimInfo, mpiSimulation (2) DumpReader, DumpWriter (InitializeFrom File will be removed) (3) ForceField (at least LJ) and BondType, BendType, TorsionType (4)Integrator (5)oopse.cpp (6)visitors & Dump2XYZ (7)SimpleBuilder (8)Constraint & ZConstraint
#	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
38			#include <string.h>
39			#include <iostream>
40			#include <fstream>
41
42			#include "brains/Stats.hpp"
43
44			namespace oopse {
45
46			typedef std::bitset<Stats::ENDINDEX-Stats:BEGININDEX> StatsBitSet;
47
48			/**
49			* DefaultStatsBitSet includes
50			* StatsIndex::TOTALENERGY
51			* StatsIndex::TOTALPOTENTIAL
52			* StatsIndex::TEMPERATURE
53			* StatsIndex::PRESSURE
54			* StatsIndex::CONSERVEQUAN
55			* StatsIndex::TOTALENERGY
56			*/
57			const StatsBitSet DefaultStatsBitSet(63ul);
58
59
60			/**
61			* @class StatWriter StatWriter.hpp "io/StatWriter.hpp"
62			* @brief A configurable Statistics Writer
63			*/
64			class StatWriter {
65			public:
66	tim	1725	StatWriter(const std::string& filename, const StatsBitSet& mask = DefaultStatsBitSet);
67	tim	1724	~StatWriter();
68
69			void writeTitle();
70			void writeStat(Snapshot* s);
71
72			StatsBitSet getMask() {
73			return mask_;
74			}
75
76			private:
77
78	tim	1725	std::ofstream statfile_;
79	tim	1724	StatsBitSet mask_;
80
81			};
82
83			}
84			#endif //IO_STATWRITER_HPP