/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 2010,2011,2012,2014, 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.
*
- * G R O M A C S
+ * 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.
*
- * GROningen MAchine for Chemical Simulations
+ * 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.
*
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * 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, 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 www.gromacs.org.
+ * 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 papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
/*! \libinternal \file
* \brief
* Declares gmx::AbstractOptionStorage.
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
* \inlibraryapi
* \ingroup module_options
*/
#include <string>
-#include "../utility/common.h"
-
-#include "optionflags.h"
+#include "gromacs/options/optionflags.h"
+#include "gromacs/utility/common.h"
namespace gmx
{
bool isVector() const { return hasFlag(efOption_Vector); }
//! Returns the name of the option.
const std::string &name() const { return name_; }
- //! Returns the description of the option.
+ //! Returns the description of the option set by the calling code.
const std::string &description() const { return descr_; }
+ //! Returns true if defaultValueIfSet() value is specified.
+ bool defaultValueIfSetExists() const
+ { return hasFlag(efOption_DefaultValueIfSetExists); }
+ //! Returns the minimum number of values required in one set.
+ int minValueCount() const { return minValueCount_; }
+ //! Returns the maximum allowed number of values in one set (-1 = no limit).
+ int maxValueCount() const { return maxValueCount_; }
+
/*! \brief
* Returns an option info object corresponding to this option.
*/
virtual OptionInfo &optionInfo() = 0;
/*! \brief
* Returns a short string describing the type of the option.
+ */
+ virtual std::string typeString() const = 0;
+ /*! \brief
+ * Formats additional description for the option.
*
- * The caller is free to discard the returned string.
+ * If this method returns a non-empty string, it is appended to the
+ * plain description when printing help texts.
+ * The default implementation returns an empty string.
*/
- virtual const char *typeString() const = 0;
+ virtual std::string formatExtraDescription() const
+ { return std::string(); }
/*! \brief
* Returns the number of option values added so far.
*/
* \throws APIError if invalid settings have been provided.
*/
AbstractOptionStorage(const AbstractOption &settings,
- OptionFlags staticFlags);
+ OptionFlags staticFlags);
//! Marks the option as set.
void markAsSet() { flags_.set(efOption_Set); }
//! Clears the given flag.
void clearFlag(OptionFlag flag) { return flags_.clear(flag); }
- //! Returns the minimum number of values required in one set.
- int minValueCount() const { return minValueCount_; }
- //! Returns the maximum allowed number of values in one set (-1 = no limit).
- int maxValueCount() const { return maxValueCount_; }
/*! \brief
* Sets a new minimum number of values required in one set.
*
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff