src/gromacs/selection/selectionfileoptionstorage.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2016,2018 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.
   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  * Declares gmx::SelectionFileOptionStorage.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_selection
  42  */
  43 #ifndef GMX_SELECTION_SELECTIONFILEOPTIONSTORAGE_H
  44 #define GMX_SELECTION_SELECTIONFILEOPTIONSTORAGE_H
  45
  46 #include "gromacs/options/abstractoptionstorage.h"
  47 #include "gromacs/selection/selectionfileoption.h"
  48
  49 namespace gmx
  50 {
  51
  52 class SelectionFileOption;
  53 class SelectionOptionManager;
  54
  55 /*! \internal \brief
  56  * Implementation for a special option for reading selections from files.
  57  *
  58  * \ingroup module_selection
  59  */
  60 class SelectionFileOptionStorage : public AbstractOptionStorage
  61 {
  62 public:
  63     /*! \brief
  64      * Initializes the storage from option settings.
  65      *
  66      * \param[in] settings   Storage settings.
  67      * \param     manager    Manager for this object.
  68      */
  69     SelectionFileOptionStorage(const SelectionFileOption& settings, SelectionOptionManager* manager);
  70
  71     OptionInfo&              optionInfo() override { return info_; }
  72     std::string              typeString() const override { return "file"; }
  73     int                      valueCount() const override { return 0; }
  74     std::vector<Any>         defaultValues() const override { return {}; }
  75     std::vector<std::string> defaultValuesAsStrings() const override { return {}; }
  76     std::vector<Any>         normalizeValues(const std::vector<Any>& values) const override
  77     {
  78         return values;
  79     }
  80
  81 private:
  82     void clearSet() override;
  83     void convertValue(const Any& value) override;
  84     void processSet() override;
  85     void processAll() override {}
  86
  87     SelectionFileOptionInfo info_;
  88     SelectionOptionManager& manager_;
  89     bool                    bValueParsed_;
  90 };
  91
  92 } // namespace gmx
  93
  94 #endif