3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
9 * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
10 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
11 * Copyright (c) 2001-2009, The GROMACS development team,
12 * check out http://www.gromacs.org for more information.
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version 2
17 * of the License, or (at your option) any later version.
19 * If you want to redistribute modifications, please consider that
20 * scientific software is very special. Version control is crucial -
21 * bugs must be traceable. We will be happy to consider code for
22 * inclusion in the official distribution, but derived work must not
23 * be called official GROMACS. Details are found in the README & COPYING
24 * files - if they are missing, get the official version at www.gromacs.org.
26 * To help us fund GROMACS development, we humbly ask that you cite
27 * the papers on the package - you can find them in the top README file.
29 * For more info, check our website at http://www.gromacs.org
33 * Declares gmx::SelectionOptionStorage.
35 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
36 * \ingroup module_selection
38 #ifndef GMX_SELECTION_SELECTIONOPTIONSTORAGE_H
39 #define GMX_SELECTION_SELECTIONOPTIONSTORAGE_H
41 #include "../options/optionstoragetemplate.h"
42 #include "selection.h"
43 #include "selectionenums.h"
44 #include "selectionoptioninfo.h"
49 class SelectionOption;
50 class SelectionOptionManager;
53 * Converts, validates, and stores selection values.
55 * \see SelectionOptionManager
57 * \ingroup module_selection
59 class SelectionOptionStorage : public OptionStorageTemplate<Selection>
63 * Initializes the storage from option settings.
65 * \param[in] settings Storage settings.
67 SelectionOptionStorage(const SelectionOption &settings);
69 virtual OptionInfo &optionInfo() { return info_; }
70 virtual const char *typeString() const { return "sel"; }
71 virtual std::string formatSingleValue(const Selection &value) const;
73 //! \copydoc SelectionOptionInfo::setManager()
74 void setManager(SelectionOptionManager *manager);
77 * Adds selections to the storage.
79 * \param[in] selections List of selections to add.
80 * \param[in] bFullValue If true, the provided selections are the full
81 * value of the option, and additional checks are performed.
82 * \throws std::bad_alloc if out of memory.
83 * \throws InvalidInputError if
84 * - There is an incorrect number of selections in \p selections.
85 * - Any selection in \p selections is not allowed for this
88 * This function is used to add selections from SelectionOptionManager.
89 * It is called with \p bFullValue set to false from
90 * SelectionOptionManager::convertOptionValue(), and \p bFullValue set
91 * to true when parsing requested selections.
93 void addSelections(const SelectionList &selections,
96 // Required to access the number of values in selection requests.
97 // See SelectionCollection::Impl.
98 using MyBase::maxValueCount;
99 //! \copydoc SelectionOptionInfo::setValueCount()
100 void setAllowedValueCount(int count);
102 * Alters flags for the selections created by this option.
104 * \param[in] flag Flag to change.
105 * \param[in] bSet Whether to set or clear the flag.
106 * \throws std::bad_alloc if out of memory.
107 * \throws InvalidInputError if selections have already been
108 * provided and conflict with the given flags.
110 * If selections have already been provided, it is checked that they
111 * match the limitations enforced by the flags. Pending requests are
114 * Strong exception safety guarantee.
116 void setSelectionFlag(SelectionFlag flag, bool bSet);
119 virtual void convertValue(const std::string &value);
120 virtual void processSetValues(ValueList *values);
121 virtual void processAll();
123 SelectionOptionInfo info_;
124 SelectionOptionManager *manager_;
125 SelectionFlags selectionFlags_;