src/gromacs/trajectoryanalysis/analysissettings.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010-2018, The GROMACS development team.
   5  * Copyright (c) 2019, 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.
   9  *
  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.
  14  *
  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.
  19  *
  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.
  24  *
  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.
  32  *
  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.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Implements classes in analysissettings.h.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_trajectoryanalysis
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "analysissettings.h"
  46
  47 #include "gromacs/commandline/cmdlineoptionsmodule.h"
  48 #include "gromacs/fileio/trxio.h"
  49 #include "gromacs/utility/arrayref.h"
  50 #include "gromacs/utility/gmxassert.h"
  51
  52 #include "analysissettings_impl.h"
  53
  54 namespace gmx
  55 {
  56
  57
  58 /********************************************************************
  59  * TrajectoryAnalysisSettings
  60  */
  61
  62 TrajectoryAnalysisSettings::TrajectoryAnalysisSettings() : impl_(new Impl)
  63 {
  64     impl_->frflags |= TRX_NEED_X;
  65 }
  66
  67
  68 TrajectoryAnalysisSettings::~TrajectoryAnalysisSettings() {}
  69
  70
  71 void TrajectoryAnalysisSettings::setOptionsModuleSettings(ICommandLineOptionsModuleSettings* settings)
  72 {
  73     impl_->optionsModuleSettings_ = settings;
  74 }
  75
  76
  77 TimeUnit TrajectoryAnalysisSettings::timeUnit() const
  78 {
  79     return impl_->timeUnit;
  80 }
  81
  82
  83 const AnalysisDataPlotSettings& TrajectoryAnalysisSettings::plotSettings() const
  84 {
  85     return impl_->plotSettings;
  86 }
  87
  88
  89 unsigned long TrajectoryAnalysisSettings::flags() const
  90 {
  91     return impl_->flags;
  92 }
  93
  94
  95 bool TrajectoryAnalysisSettings::hasFlag(unsigned long flag) const
  96 {
  97     return (impl_->flags & flag) != 0U;
  98 }
  99
 100
 101 bool TrajectoryAnalysisSettings::hasPBC() const
 102 {
 103     return impl_->bPBC;
 104 }
 105
 106
 107 bool TrajectoryAnalysisSettings::hasRmPBC() const
 108 {
 109     return impl_->bRmPBC;
 110 }
 111
 112
 113 int TrajectoryAnalysisSettings::frflags() const
 114 {
 115     return impl_->frflags;
 116 }
 117
 118
 119 void TrajectoryAnalysisSettings::setFlags(unsigned long flags)
 120 {
 121     impl_->flags = flags;
 122 }
 123
 124
 125 void TrajectoryAnalysisSettings::setFlag(unsigned long flag, bool bSet)
 126 {
 127     if (bSet)
 128     {
 129         impl_->flags |= flag;
 130     }
 131     else
 132     {
 133         impl_->flags &= ~flag;
 134     }
 135 }
 136
 137
 138 void TrajectoryAnalysisSettings::setPBC(bool bPBC)
 139 {
 140     impl_->bPBC = bPBC;
 141 }
 142
 143
 144 void TrajectoryAnalysisSettings::setRmPBC(bool bRmPBC)
 145 {
 146     impl_->bRmPBC = bRmPBC;
 147 }
 148
 149
 150 void TrajectoryAnalysisSettings::setFrameFlags(int frflags)
 151 {
 152     impl_->frflags = frflags;
 153 }
 154
 155 void TrajectoryAnalysisSettings::setHelpText(const ArrayRef<const char* const>& help)
 156 {
 157     GMX_RELEASE_ASSERT(impl_->optionsModuleSettings_ != nullptr,
 158                        "setHelpText() called in invalid context");
 159     impl_->optionsModuleSettings_->setHelpText(help);
 160 }
 161
 162 } // namespace gmx