2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012, 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.
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.
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.
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.
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.
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.
37 * Declares gmx::SelectionOptionStorage.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_selection
42 #ifndef GMX_SELECTION_SELECTIONOPTIONSTORAGE_H
43 #define GMX_SELECTION_SELECTIONOPTIONSTORAGE_H
45 #include "../options/optionstoragetemplate.h"
46 #include "selection.h"
47 #include "selectionenums.h"
48 #include "selectionoption.h"
53 class SelectionOption;
54 class SelectionOptionManager;
57 * Converts, validates, and stores selection values.
59 * \see SelectionOptionManager
61 * \ingroup module_selection
63 class SelectionOptionStorage : public OptionStorageTemplate<Selection>
67 * Initializes the storage from option settings.
69 * \param[in] settings Storage settings.
71 SelectionOptionStorage(const SelectionOption &settings);
73 virtual OptionInfo &optionInfo() { return info_; }
74 virtual const char *typeString() const { return "sel"; }
75 virtual std::string formatSingleValue(const Selection &value) const;
77 //! \copydoc SelectionOptionInfo::setManager()
78 void setManager(SelectionOptionManager *manager);
81 * Adds selections to the storage.
83 * \param[in] selections List of selections to add.
84 * \param[in] bFullValue If true, the provided selections are the full
85 * value of the option, and additional checks are performed.
86 * \throws std::bad_alloc if out of memory.
87 * \throws InvalidInputError if
88 * - There is an incorrect number of selections in \p selections.
89 * - Any selection in \p selections is not allowed for this
92 * This function is used to add selections from SelectionOptionManager.
93 * It is called with \p bFullValue set to false from
94 * SelectionOptionManager::convertOptionValue(), and \p bFullValue set
95 * to true when parsing requested selections.
97 void addSelections(const SelectionList &selections,
100 // Required to access the number of values in selection requests.
101 // See SelectionCollection::Impl.
102 using MyBase::maxValueCount;
103 //! \copydoc SelectionOptionInfo::setValueCount()
104 void setAllowedValueCount(int count);
106 * Alters flags for the selections created by this option.
108 * \param[in] flag Flag to change.
109 * \param[in] bSet Whether to set or clear the flag.
110 * \throws std::bad_alloc if out of memory.
111 * \throws InvalidInputError if selections have already been
112 * provided and conflict with the given flags.
114 * If selections have already been provided, it is checked that they
115 * match the limitations enforced by the flags. Pending requests are
118 * Strong exception safety guarantee.
120 void setSelectionFlag(SelectionFlag flag, bool bSet);
123 virtual void convertValue(const std::string &value);
124 virtual void processSetValues(ValueList *values);
125 virtual void processAll();
127 SelectionOptionInfo info_;
128 SelectionOptionManager *manager_;
129 SelectionFlags selectionFlags_;