Use separate class for data storage.
[alexxy/gromacs.git] / src / gromacs / trajectoryanalysis / modules / select.h
1 /*
2  *
3  *                This source code is part of
4  *
5  *                 G   R   O   M   A   C   S
6  *
7  *          GROningen MAchine for Chemical Simulations
8  *
9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
11  * Copyright (c) 2001-2009, The GROMACS development team,
12  * check out http://www.gromacs.org for more information.
13
14  * This program is free software; you can redistribute it and/or
15  * modify it under the terms of the GNU General Public License
16  * as published by the Free Software Foundation; either version 2
17  * of the License, or (at your option) any later version.
18  *
19  * If you want to redistribute modifications, please consider that
20  * scientific software is very special. Version control is crucial -
21  * bugs must be traceable. We will be happy to consider code for
22  * inclusion in the official distribution, but derived work must not
23  * be called official GROMACS. Details are found in the README & COPYING
24  * files - if they are missing, get the official version at www.gromacs.org.
25  *
26  * To help us fund GROMACS development, we humbly ask that you cite
27  * the papers on the package - you can find them in the top README file.
28  *
29  * For more info, check our website at http://www.gromacs.org
30  */
31 /*! \internal \file
32  * \brief
33  * Declares trajectory analysis module for basic selection information.
34  *
35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
36  * \ingroup module_trajectoryanalysis
37  */
38 #ifndef GMX_TRAJECTORYANALYSIS_MODULES_SELECT_H
39 #define GMX_TRAJECTORYANALYSIS_MODULES_SELECT_H
40
41 #include <string>
42 #include <vector>
43
44 #include "../analysismodule.h"
45 #include "gromacs/analysisdata/analysisdata.h"
46 #include "gromacs/options/options.h"
47
48 namespace gmx
49 {
50
51 class AnalysisDataPlotModule;
52 class Selection;
53
54 namespace analysismodules
55 {
56
57 class Select : public TrajectoryAnalysisModule
58 {
59     public:
60         Select();
61         virtual ~Select();
62
63         static TrajectoryAnalysisModule *create();
64
65         virtual Options *initOptions(TrajectoryAnalysisSettings *settings);
66         virtual void initAnalysis(const TrajectoryAnalysisSettings &settings,
67                                   const TopologyInformation &top);
68
69         virtual TrajectoryAnalysisModuleData *startFrames(
70                     const AnalysisDataParallelOptions &opt,
71                     const SelectionCollection &selections);
72         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
73                                   TrajectoryAnalysisModuleData *pdata);
74
75         virtual void finishAnalysis(int nframes);
76         virtual void writeOutput();
77
78     private:
79         class ModuleData;
80
81         Options                  _options;
82         std::vector<Selection *> _sel;
83
84         std::string              _fnSize;
85         std::string              _fnFrac;
86         std::string              _fnIndex;
87         std::string              _fnNdx;
88         std::string              _fnMask;
89         bool                     _bDump;
90         bool                     _bTotNorm;
91         bool                     _bFracNorm;
92         bool                     _bResInd;
93         std::string              _resNumberType;
94
95         t_topology              *_top;
96         int                     *_totsize;
97         AnalysisData             _sdata;
98         AnalysisData             _cdata;
99         AnalysisData             _idata;
100         AnalysisData             _mdata;
101         std::vector<std::string> _modnames;
102 };
103
104 } // namespace analysismodules
105
106 } // namespace gmx
107
108 #endif