Gromacs
5.1.5
|
#include <gromacs/options/options.h>
Collection of options.
This class provides a standard interface for implementing input options. Standard usage is to write a method that creates an Options that is owned by the object, populates it with supported options, and then returns it:
The caller of that method can then use a parser implementation such as CommandLineParser to provide values for the options.
Header basicoptions.h provides declarations of several standard option types for use with addOption(). Documentation of those classes also give more examples of how to define options.
In order to keep the public interface of this class simple and to reduce build dependencies on objects that simply provide options, functionality to assign values to options is provided by a separate OptionsAssigner class. Similarly, functionality for looping over all options (e.g., for writing out help) is provided by OptionsIterator.
Public Member Functions | |
Options (const char *name, const char *title) | |
Initializes the name and title of an option collection. More... | |
const std::string & | name () const |
Returns the short name of the option collection. | |
const std::string & | title () const |
Returns the title of the option collection. | |
const std::string & | description () const |
Returns the full description of the option collection. | |
void | setDescription (const std::string &desc) |
Sets the full description of the option collection. More... | |
void | setDescription (const ConstArrayRef< const char * > &descArray) |
Sets the full description of the option collection from string array. More... | |
void | addManager (OptionManagerInterface *manager) |
Adds an option manager. More... | |
void | addSubSection (Options *section) |
Adds an option collection as a subsection of this collection. More... | |
OptionInfo * | addOption (const AbstractOption &settings) |
Adds a recognized option to the collection. More... | |
template<class OptionType > | |
OptionType::InfoType * | addOption (const OptionType &settings) |
Adds a recognized option to the collection. More... | |
bool | isSet (const char *name) const |
Returns true if option name is set. | |
void | finish () |
Notifies the collection that all option values are assigned. More... | |
gmx::Options::Options | ( | const char * | name, |
const char * | title | ||
) |
Initializes the name and title of an option collection.
[in] | name | Single-word name. |
[in] | title | Descriptive title. |
Copies the input strings.
void gmx::Options::addManager | ( | OptionManagerInterface * | manager | ) |
Adds an option manager.
manager | Manager to add. |
std::bad_alloc | if out of memory. |
Option managers are used by some types of options that require interaction between different option instances (e.g., selection options), or need to support globally set properties (e.g., a global default file prefix). Option objects can retrieve the pointer to their manager when they are created, and the caller can alter the behavior of the options through the manager. See the individual managers for details.
Caller is responsible for memory management of manager
. The Options object (and its contained options) only stores a reference to the object.
This method cannot be called after adding options or subsections.
OptionInfo * gmx::Options::addOption | ( | const AbstractOption & | settings | ) |
Adds a recognized option to the collection.
[in] | settings | Option description. |
APIError | if invalid option settings are provided. |
This method provides the internal implementation, but in most cases the templated method is called from user code. See the templated method for more details.
|
inline |
Adds a recognized option to the collection.
OptionType | Type of the options description object. |
[in] | settings | Option description. |
APIError | if invalid option settings are provided. |
The return value is a pointer for more convenient use in callers: often callers need to declare the variable that will hold the return value in wider scope than would be achieved by declaring it at the site where addOption() is called. The returned pointer must not be freed.
See class documentation for example usage.
void gmx::Options::addSubSection | ( | Options * | section | ) |
Adds an option collection as a subsection of this collection.
[in] | section | Subsection to add. |
The name() field of section
is used as the name of the subsection. If an attempt is made to add two different subsections with the same name, this function asserts.
section
should not have any options added at the point this method is called.
Only a pointer to the provided object is stored. The caller is responsible that the object exists for the lifetime of the collection. It is not possible to add the same Options object as a subsection to several different Options. If an attempt is made, the function asserts.
void gmx::Options::finish | ( | ) |
Notifies the collection that all option values are assigned.
InvalidInputError | if invalid user input is detected. |
This function should be called after no more option values are to be assigned. Values in storage variables are guaranteed to be available only after this call, although in most cases, they are available already during assignment.
If invalid option values, e.g., missing required option, is detected at this point, this function throws. The thrown exception contains information on all errors detected during the call.
void gmx::Options::setDescription | ( | const std::string & | desc | ) |
Sets the full description of the option collection.
[in] | desc | String to set as the description. |
This overload is mainly useful if the description is very short. Currently this is mostly the case in unit testing.
void gmx::Options::setDescription | ( | const ConstArrayRef< const char * > & | descArray | ) |
Sets the full description of the option collection from string array.
[in] | descArray | String array to set as the description. |
All strings in descArray
are concatenated to form the description. Spaces are inserted between strings if they are missing.
Example usage:
To use this overload, you must also include gromacs/utility/arrayref.h
.