Merge "Improve selection interface (remove some pointers)."
[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
43 #include "../analysismodule.h"
44 #include "gromacs/analysisdata/analysisdata.h"
45 #include "gromacs/options/options.h"
46 #include "gromacs/selection/selection.h"
47
48 namespace gmx
49 {
50
51 namespace analysismodules
52 {
53
54 class Select : public TrajectoryAnalysisModule
55 {
56     public:
57         Select();
58         virtual ~Select();
59
60         static TrajectoryAnalysisModulePointer create();
61
62         virtual Options &initOptions(TrajectoryAnalysisSettings *settings);
63         virtual void initAnalysis(const TrajectoryAnalysisSettings &settings,
64                                   const TopologyInformation &top);
65
66         virtual TrajectoryAnalysisModuleDataPointer startFrames(
67                     const AnalysisDataParallelOptions &opt,
68                     const SelectionCollection &selections);
69         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
70                                   TrajectoryAnalysisModuleData *pdata);
71
72         virtual void finishAnalysis(int nframes);
73         virtual void writeOutput();
74
75     private:
76         class ModuleData;
77
78         Options                  _options;
79         SelectionList            _sel;
80
81         std::string              _fnSize;
82         std::string              _fnFrac;
83         std::string              _fnIndex;
84         std::string              _fnNdx;
85         std::string              _fnMask;
86         bool                     _bDump;
87         bool                     _bTotNorm;
88         bool                     _bFracNorm;
89         bool                     _bResInd;
90         std::string              _resNumberType;
91
92         t_topology              *_top;
93         int                     *_totsize;
94         AnalysisData             _sdata;
95         AnalysisData             _cdata;
96         AnalysisData             _idata;
97         AnalysisData             _mdata;
98 };
99
100 } // namespace analysismodules
101
102 } // namespace gmx
103
104 #endif