src/gromacs/selection/selectionoptionstorage.h

   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  * Declares gmx::SelectionOptionStorage.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_selection
  42  */
  43 #ifndef GMX_SELECTION_SELECTIONOPTIONSTORAGE_H
  44 #define GMX_SELECTION_SELECTIONOPTIONSTORAGE_H
  45
  46 #include <string>
  47
  48 #include "gromacs/options/optionstoragetemplate.h"
  49 #include "gromacs/selection/selection.h"
  50 #include "gromacs/selection/selectionoption.h"
  51
  52 #include "selectionenums.h"
  53
  54 namespace gmx
  55 {
  56
  57 class SelectionOption;
  58 class SelectionOptionManager;
  59
  60 /*! \internal \brief
  61  * Converts, validates, and stores selection values.
  62  *
  63  * \see SelectionOptionManager
  64  *
  65  * \ingroup module_selection
  66  */
  67 class SelectionOptionStorage : public OptionStorageTemplate<Selection>
  68 {
  69 public:
  70     /*! \brief
  71      * Initializes the storage from option settings.
  72      *
  73      * \param[in] settings   Storage settings.
  74      * \param     manager    Manager for this object.
  75      */
  76     SelectionOptionStorage(const SelectionOption& settings, SelectionOptionManager* manager);
  77
  78     OptionInfo&      optionInfo() override { return info_; }
  79     std::string      typeString() const override { return "selection"; }
  80     std::string      formatSingleValue(const Selection& value) const override;
  81     std::vector<Any> normalizeValues(const std::vector<Any>& 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, bool bFullValue);
 101
 102     // Required to access the number of values in selection requests.
 103     // See SelectionCollection::Impl.
 104     using MyBase::maxValueCount;
 105     //! Whether the option allows only atom-valued selections.
 106     bool allowsOnlyAtoms() const { return selectionFlags_.test(efSelection_OnlyAtoms); }
 107     //! \copydoc SelectionOptionInfo::setValueCount()
 108     void setAllowedValueCount(int count);
 109     /*! \brief
 110      * Alters flags for the selections created by this option.
 111      *
 112      * \param[in] flag        Flag to change.
 113      * \param[in] bSet        Whether to set or clear the flag.
 114      * \throws    std::bad_alloc if out of memory.
 115      * \throws    InvalidInputError if selections have already been
 116      *      provided and conflict with the given flags.
 117      *
 118      * If selections have already been provided, it is checked that they
 119      * match the limitations enforced by the flags.  Pending requests are
 120      * also affected.
 121      *
 122      * Strong exception safety guarantee.
 123      */
 124     void setSelectionFlag(SelectionFlag flag, bool bSet);
 125
 126 private:
 127     void convertValue(const Any& value) override;
 128     void processSetValues(ValueList* values) override;
 129     void processAll() override;
 130
 131     SelectionOptionInfo     info_;
 132     SelectionOptionManager& manager_;
 133     std::string             defaultText_;
 134     SelectionFlags          selectionFlags_;
 135 };
 136
 137 } // namespace gmx
 138
 139 #endif