src/brains/Stats.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 Stats.hpp
  * @author tlin
  * @date 11/04/2004
  * @time 23:56am
  * @version 1.0
  */

#ifndef BRAINS_STATS_HPP
#define BRAINS_STATS_HPP

#include <string>

namespace oopse {

/**
 * @class Stats Stats.hpp "brains/Stats.hpp"
 */
class Stats{
    public:
        enum StatsIndex {
            BEGININDEX = 0,  //internal use
            TIME = BEGININDEX,
            TOTAL_ENERGY,
            POTENTIAL_ENERGY,
            KINETIC_ENERGY,
            TEMPERATURE,
            PRESSURE,
            CONSERVED_QUANTITY,             
            TRANSLATIONAL_KINETIC,
            ROTATIONAL_KINETIC,
            LONG_RANGE_POTENTIAL,
            SHORT_RANGE_POTENTIAL,
            VANDERWAALS_POTENTIAL,
            ELECTROSTATIC_POTENTIAL,
            BOND_POTENTIAL,
            BEND_POTENTIAL,
            DIHEDRAL_POTENTIAL,
            IMPROPER_POTENTIAL,
            VRAW,
            VHARM,
            ENDINDEX  //internal use
        };

        const double& operator [](StatsIndex index) const {
            return data_[static_cast<int>(index)];
        }

        double& operator [](StatsIndex index){
            return data_[static_cast<int>(index)];
        }
        
        static std::string getTitle(StatsIndex index) {
            return title_[static_cast<int>(index)];
        }

        static std::string getUnits(StatsIndex index) {
            return units_[static_cast<int>(index)];
        }
        
    private:
        
        double data_[ENDINDEX - BEGININDEX];
        static std::string title_[ENDINDEX - BEGININDEX];
        static std::string units_[ENDINDEX - BEGININDEX];
};

} //end namespace oopse
#endif //BRAINS_STATS_HPP
Revision:	1726
Committed:	Wed Nov 10 22:50:03 2004 UTC (19 years, 9 months ago) by tim
File size:	2832 byte(s)
Log Message:	more work on SimInfo
#	User	Rev	Content
1	tim	1710	/*
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 Stats.hpp
28			* @author tlin
29			* @date 11/04/2004
30			* @time 23:56am
31			* @version 1.0
32			*/
33
34			#ifndef BRAINS_STATS_HPP
35			#define BRAINS_STATS_HPP
36
37			#include <string>
38
39			namespace oopse {
40
41			/**
42			* @class Stats Stats.hpp "brains/Stats.hpp"
43			*/
44			class Stats{
45			public:
46			enum StatsIndex {
47	tim	1726	BEGININDEX = 0, //internal use
48			TIME = BEGININDEX,
49			TOTAL_ENERGY,
50			POTENTIAL_ENERGY,
51			KINETIC_ENERGY,
52	tim	1710	TEMPERATURE,
53			PRESSURE,
54	tim	1726	CONSERVED_QUANTITY,
55			TRANSLATIONAL_KINETIC,
56			ROTATIONAL_KINETIC,
57			LONG_RANGE_POTENTIAL,
58			SHORT_RANGE_POTENTIAL,
59			VANDERWAALS_POTENTIAL,
60			ELECTROSTATIC_POTENTIAL,
61			BOND_POTENTIAL,
62			BEND_POTENTIAL,
63			DIHEDRAL_POTENTIAL,
64			IMPROPER_POTENTIAL,
65	tim	1721	VRAW,
66			VHARM,
67	tim	1712	ENDINDEX //internal use
68	tim	1710	};
69
70			const double& operator [](StatsIndex index) const {
71			return data_[static_cast<int>(index)];
72			}
73
74			double& operator [](StatsIndex index){
75			return data_[static_cast<int>(index)];
76			}
77
78	tim	1712	static std::string getTitle(StatsIndex index) {
79	tim	1710	return title_[static_cast<int>(index)];
80			}
81	tim	1726
82			static std::string getUnits(StatsIndex index) {
83			return units_[static_cast<int>(index)];
84			}
85	tim	1710
86			private:
87
88			double data_[ENDINDEX - BEGININDEX];
89			static std::string title_[ENDINDEX - BEGININDEX];
90	tim	1726	static std::string units_[ENDINDEX - BEGININDEX];
91	tim	1710	};
92
93			} //end namespace oopse
94			#endif //BRAINS_STATS_HPP