2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012,2014,2015 by the GROMACS development team.
5 * Copyright (c) 2019,2020, by the GROMACS development team, led by
6 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
7 * and including many others, as listed in the AUTHORS file in the
8 * top-level source directory and at http://www.gromacs.org.
10 * GROMACS is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public License
12 * as published by the Free Software Foundation; either version 2.1
13 * of the License, or (at your option) any later version.
15 * GROMACS 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 GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with GROMACS; if not, see
22 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * If you want to redistribute modifications to GROMACS, please
26 * consider that scientific software is very special. Version
27 * control is crucial - bugs must be traceable. We will be happy to
28 * consider code for inclusion in the official distribution, but
29 * derived work must not be called official GROMACS. Details are found
30 * in the README & COPYING files - if they are missing, get the
31 * official version at http://www.gromacs.org.
33 * To help us fund GROMACS development, we humbly ask that you cite
34 * the research papers on the package. Check out http://www.gromacs.org.
38 * Declares private implementation class for gmx::TrajectoryAnalysisSettings.
40 * \ingroup module_trajectoryanalysis
41 * \author Teemu Murtola <teemu.murtola@gmail.com>
43 #ifndef GMX_TRAJECTORYANALYSIS_ANALYSISSETTINGS_IMPL_H
44 #define GMX_TRAJECTORYANALYSIS_ANALYSISSETTINGS_IMPL_H
48 #include "gromacs/analysisdata/modules/plot.h"
49 #include "gromacs/options/timeunitmanager.h"
50 #include "gromacs/trajectoryanalysis/analysissettings.h"
55 class ICommandLineOptionsModuleSettings
;
58 * Private implementation class for TrajectoryAnalysisSettings.
60 * \ingroup module_trajectoryanalysis
62 class TrajectoryAnalysisSettings::Impl
65 //! Initializes the default values for the settings object.
67 timeUnit(TimeUnit_Default
),
72 optionsModuleSettings_(nullptr)
76 //! Global time unit setting for the analysis module.
78 //! Global plotting settings for the analysis module.
79 AnalysisDataPlotSettings plotSettings
;
80 //! Flags for the analysis module.
82 //! Frame reading flags for the analysis module.
85 //! Whether to make molecules whole for each frame.
87 //! Whether to pass PBC information to the analysis module.
90 //! Lower-level settings object wrapped by these settings.
91 ICommandLineOptionsModuleSettings
* optionsModuleSettings_
;