src/gromacs/trajectoryanalysis/analysissettings.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014,2015,2016,2017,2018,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements classes in analysissettings.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_trajectoryanalysis
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "analysissettings.h"
  45
  46 #include "gromacs/commandline/cmdlineoptionsmodule.h"
  47 #include "gromacs/fileio/trxio.h"
  48 #include "gromacs/utility/arrayref.h"
  49 #include "gromacs/utility/gmxassert.h"
  50
  51 #include "analysissettings_impl.h"
  52
  53 namespace gmx
  54 {
  55
  56
  57 /********************************************************************
  58  * TrajectoryAnalysisSettings
  59  */
  60
  61 TrajectoryAnalysisSettings::TrajectoryAnalysisSettings()
  62     : impl_(new Impl)
  63 {
  64     impl_->frflags |= TRX_NEED_X;
  65 }
  66
  67
  68 TrajectoryAnalysisSettings::~TrajectoryAnalysisSettings()
  69 {
  70 }
  71
  72
  73 void TrajectoryAnalysisSettings::setOptionsModuleSettings(
  74         ICommandLineOptionsModuleSettings *settings)
  75 {
  76     impl_->optionsModuleSettings_ = settings;
  77 }
  78
  79
  80 TimeUnit
  81 TrajectoryAnalysisSettings::timeUnit() const
  82 {
  83     return impl_->timeUnit;
  84 }
  85
  86
  87 const AnalysisDataPlotSettings &
  88 TrajectoryAnalysisSettings::plotSettings() const
  89 {
  90     return impl_->plotSettings;
  91 }
  92
  93
  94 unsigned long
  95 TrajectoryAnalysisSettings::flags() const
  96 {
  97     return impl_->flags;
  98 }
  99
 100
 101 bool
 102 TrajectoryAnalysisSettings::hasFlag(unsigned long flag) const
 103 {
 104     return (impl_->flags & flag) != 0u;
 105 }
 106
 107
 108 bool
 109 TrajectoryAnalysisSettings::hasPBC() const
 110 {
 111     return impl_->bPBC;
 112 }
 113
 114
 115 bool
 116 TrajectoryAnalysisSettings::hasRmPBC() const
 117 {
 118     return impl_->bRmPBC;
 119 }
 120
 121
 122 int
 123 TrajectoryAnalysisSettings::frflags() const
 124 {
 125     return impl_->frflags;
 126 }
 127
 128
 129 void
 130 TrajectoryAnalysisSettings::setFlags(unsigned long flags)
 131 {
 132     impl_->flags = flags;
 133 }
 134
 135
 136 void
 137 TrajectoryAnalysisSettings::setFlag(unsigned long flag, bool bSet)
 138 {
 139     if (bSet)
 140     {
 141         impl_->flags |= flag;
 142     }
 143     else
 144     {
 145         impl_->flags &= ~flag;
 146     }
 147 }
 148
 149
 150 void
 151 TrajectoryAnalysisSettings::setPBC(bool bPBC)
 152 {
 153     impl_->bPBC = bPBC;
 154 }
 155
 156
 157 void
 158 TrajectoryAnalysisSettings::setRmPBC(bool bRmPBC)
 159 {
 160     impl_->bRmPBC = bRmPBC;
 161 }
 162
 163
 164 void
 165 TrajectoryAnalysisSettings::setFrameFlags(int frflags)
 166 {
 167     impl_->frflags = frflags;
 168 }
 169
 170 void
 171 TrajectoryAnalysisSettings::setHelpText(const ArrayRef<const char *const> &help)
 172 {
 173     GMX_RELEASE_ASSERT(impl_->optionsModuleSettings_ != nullptr,
 174                        "setHelpText() called in invalid context");
 175     impl_->optionsModuleSettings_->setHelpText(help);
 176 }
 177
 178 } // namespace gmx