/usr/include/gromacs/options/ioptionscontainer.h is in libgromacs-dev 2018.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 | /*
* This file is part of the GROMACS molecular simulation package.
*
* Copyright (c) 2015,2016, by the GROMACS development team, led by
* Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
* and including many others, as listed in the AUTHORS file in the
* top-level source directory and at http://www.gromacs.org.
*
* GROMACS is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* GROMACS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with GROMACS; if not, see
* http://www.gnu.org/licenses, or write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* If you want to redistribute modifications to GROMACS, please
* consider that scientific software is very special. Version
* control is crucial - bugs must be traceable. We will be happy to
* consider code for inclusion in the official distribution, but
* derived work must not be called official GROMACS. Details are found
* in the README & COPYING files - if they are missing, get the
* official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
* the research papers on the package. Check out http://www.gromacs.org.
*/
/*! \file
* \brief
* Declares gmx::IOptionsContainer.
*
* \author Teemu Murtola <teemu.murtola@gmail.com>
* \inpublicapi
* \ingroup module_options
*/
#ifndef GMX_OPTIONS_IOPTIONSCONTAINER_H
#define GMX_OPTIONS_IOPTIONSCONTAINER_H
#include "gromacs/options/abstractoption.h"
#include "gromacs/utility/gmxassert.h"
namespace gmx
{
/*! \brief
* Interface for adding input options.
*
* This interface provides methods to add new options.
* Standard usage is for code to receive this interface and populate it with
* supported options:
* \code
// <as class attributes>
std::string arg1;
int arg2;
void MyClass::initOptions(gmx::IOptionsContainer *options)
{
options->addOption(gmx::StringOption("arg1").store(&arg1));
options->addOption(gmx::IntegerOption("arg2").store(&arg2));
}
\endcode
* The caller can collect options from multiple sources into a single container
* (a gmx::Options), and 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.
*
* \inpublicapi
* \ingroup module_options
*/
class IOptionsContainer
{
public:
/*! \brief
* Creates a subgroup of options within the current options.
*
* To add options to the group, use the returned interface.
*
* Currently, this is only used to influence the order of options:
* all options in a group appear before options in a group added after
* it, no matter in which order the options are added to the groups.
* In the future, the groups could also be used to influence the help
* output.
*/
virtual IOptionsContainer &addGroup() = 0;
/*! \brief
* Adds a recognized option.
*
* \tparam OptionType Type of the options description object.
* \param[in] settings Option description.
* \returns OptionInfo object for the created option (never NULL).
* \throws 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 \link Options class documentation \endlink for example usage.
*
* \libinternal
* \p OptionType::InfoType must specify a type that derives from
* OptionInfo and matches the type that is returned by
* AbstractOptionStorage::optionInfo() for the storage object that
* corresponds to \p OptionType.
*/
template <class OptionType>
typename OptionType::InfoType *addOption(const OptionType &settings)
{
OptionInfo *info
= addOptionImpl(static_cast<const AbstractOption &>(settings));
GMX_ASSERT(info->isType<typename OptionType::InfoType>(),
"Mismatching option info type declaration and implementation");
return info->toType<typename OptionType::InfoType>();
}
protected:
// Disallow deletion through the interface.
// (no need for the virtual, but some compilers warn otherwise)
virtual ~IOptionsContainer();
/*! \brief
* Adds a recognized option.
*
* \param[in] settings Option description.
* \returns OptionInfo object for the created option (never NULL).
* \throws APIError if invalid option settings are provided.
*
* This method provides the internal implementation, but the templated
* method is called from user code. See the templated method for more
* details.
*/
virtual OptionInfo *addOptionImpl(const AbstractOption &settings) = 0;
GMX_DEFAULT_CONSTRUCTORS(IOptionsContainer);
};
} // namespace
#endif
|