src/gromacs/selection/selectionoptionstorage.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014,2015,2016,2018, 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  * Declares gmx::SelectionOptionStorage.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #ifndef GMX_SELECTION_SELECTIONOPTIONSTORAGE_H
  43 #define GMX_SELECTION_SELECTIONOPTIONSTORAGE_H
  44
  45 #include <string>
  46
  47 #include "gromacs/options/optionstoragetemplate.h"
  48 #include "gromacs/selection/selection.h"
  49 #include "gromacs/selection/selectionenums.h"
  50 #include "gromacs/selection/selectionoption.h"
  51
  52 namespace gmx
  53 {
  54
  55 class SelectionOption;
  56 class SelectionOptionManager;
  57
  58 /*! \internal \brief
  59  * Converts, validates, and stores selection values.
  60  *
  61  * \see SelectionOptionManager
  62  *
  63  * \ingroup module_selection
  64  */
  65 class SelectionOptionStorage : public OptionStorageTemplate<Selection>
  66 {
  67     public:
  68         /*! \brief
  69          * Initializes the storage from option settings.
  70          *
  71          * \param[in] settings   Storage settings.
  72          * \param     manager    Manager for this object.
  73          */
  74         SelectionOptionStorage(const SelectionOption  &settings,
  75                                SelectionOptionManager *manager);
  76
  77         OptionInfo &optionInfo() override { return info_; }
  78         std::string typeString() const override { return "selection"; }
  79         std::string formatSingleValue(const Selection &value) const override;
  80         std::vector<Variant>
  81         normalizeValues(const std::vector<Variant> &values) const override;
  82
  83         /*! \brief
  84          * Adds selections to the storage.
  85          *
  86          * \param[in] selections  List of selections to add.
  87          * \param[in] bFullValue  If true, the provided selections are the full
  88          *      value of the option, and additional checks are performed.
  89          * \throws  std::bad_alloc if out of memory.
  90          * \throws  InvalidInputError if
  91          *      - There is an incorrect number of selections in \p selections.
  92          *      - Any selection in \p selections is not allowed for this
  93          *        option.
  94          *
  95          * This function is used to add selections from SelectionOptionManager.
  96          * It is called with \p bFullValue set to false from
  97          * SelectionOptionManager::convertOptionValue(), and \p bFullValue set
  98          * to true when parsing requested selections.
  99          */
 100         void addSelections(const SelectionList &selections,
 101                            bool                 bFullValue);
 102
 103         // Required to access the number of values in selection requests.
 104         // See SelectionCollection::Impl.
 105         using MyBase::maxValueCount;
 106         //! Whether the option allows only atom-valued selections.
 107         bool allowsOnlyAtoms() const
 108         {
 109             return selectionFlags_.test(efSelection_OnlyAtoms);
 110         }
 111         //! \copydoc SelectionOptionInfo::setValueCount()
 112         void setAllowedValueCount(int count);
 113         /*! \brief
 114          * Alters flags for the selections created by this option.
 115          *
 116          * \param[in] flag        Flag to change.
 117          * \param[in] bSet        Whether to set or clear the flag.
 118          * \throws    std::bad_alloc if out of memory.
 119          * \throws    InvalidInputError if selections have already been
 120          *      provided and conflict with the given flags.
 121          *
 122          * If selections have already been provided, it is checked that they
 123          * match the limitations enforced by the flags.  Pending requests are
 124          * also affected.
 125          *
 126          * Strong exception safety guarantee.
 127          */
 128         void setSelectionFlag(SelectionFlag flag, bool bSet);
 129
 130     private:
 131         void convertValue(const Variant &value) override;
 132         void processSetValues(ValueList *values) override;
 133         void processAll() override;
 134
 135         SelectionOptionInfo     info_;
 136         SelectionOptionManager &manager_;
 137         std::string             defaultText_;
 138         SelectionFlags          selectionFlags_;
 139 };
 140
 141 } // namespace gmx
 142
 143 #endif