/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 2010,2011,2012,2013,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.
*/
/*! \internal \file
* \brief
* Declares storage classes for basic option types.
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
* \ingroup module_options
*/
#ifndef GMX_OPTIONS_BASICOPTIONSTORAGE_H
#include <string>
#include <vector>
-#include "optionfiletype.h"
+#include "basicoptions.h"
#include "optionstoragetemplate.h"
namespace gmx
{
-class BooleanOption;
-class IntegerOption;
-class DoubleOption;
-class StringOption;
-class FileNameOption;
-
/*! \addtogroup module_options
* \{
*/
* Initializes the storage from option settings.
*
* \param[in] settings Storage settings.
- * \param[in] options Options object.
*/
- BooleanOptionStorage(const BooleanOption &settings, Options *options)
- : MyBase(settings, options)
+ explicit BooleanOptionStorage(const BooleanOption &settings)
+ : MyBase(settings), info_(this)
{
}
- virtual const char *typeString() const { return "bool"; }
- virtual std::string formatValue(int i) const;
+ virtual OptionInfo &optionInfo() { return info_; }
+ virtual std::string typeString() const { return "bool"; }
+ virtual std::string formatSingleValue(const bool &value) const;
+
+ //! \copydoc BooleanOptionInfo::defaultValue()
+ bool defaultValue() const { return valueCount() > 0 && values()[0]; }
private:
virtual void convertValue(const std::string &value);
+
+ BooleanOptionInfo info_;
};
/*! \internal \brief
{
public:
//! \copydoc BooleanOptionStorage::BooleanOptionStorage()
- IntegerOptionStorage(const IntegerOption &settings, Options *options)
- : MyBase(settings, options)
+ explicit IntegerOptionStorage(const IntegerOption &settings)
+ : MyBase(settings), info_(this)
{
}
- virtual const char *typeString() const
- { return hasFlag(efVector) ? "vector" : "int"; }
- virtual std::string formatValue(int i) const;
+ virtual OptionInfo &optionInfo() { return info_; }
+ virtual std::string typeString() const
+ { return isVector() ? "vector" : "int"; }
+ virtual std::string formatSingleValue(const int &value) const;
private:
virtual void convertValue(const std::string &value);
virtual void processSetValues(ValueList *values);
+
+ IntegerOptionInfo info_;
+};
+
+/*! \internal \brief
+ * Converts, validates, and stores integer values.
+ */
+class Int64OptionStorage : public OptionStorageTemplate<gmx_int64_t>
+{
+ public:
+ //! \copydoc BooleanOptionStorage::BooleanOptionStorage()
+ explicit Int64OptionStorage(const Int64Option &settings)
+ : MyBase(settings), info_(this)
+ {
+ }
+
+ virtual OptionInfo &optionInfo() { return info_; }
+ virtual std::string typeString() const { return "int"; }
+ virtual std::string formatSingleValue(const gmx_int64_t &value) const;
+
+ private:
+ virtual void convertValue(const std::string &value);
+
+ Int64OptionInfo info_;
};
/*! \internal \brief
{
public:
//! \copydoc IntegerOptionStorage::IntegerOptionStorage()
- DoubleOptionStorage(const DoubleOption &settings, Options *options);
+ explicit DoubleOptionStorage(const DoubleOption &settings);
+
+ virtual OptionInfo &optionInfo() { return info_; }
+ virtual std::string typeString() const;
+ virtual std::string formatSingleValue(const double &value) const;
- virtual const char *typeString() const;
- virtual std::string formatValue(int i) const;
+ //! \copydoc DoubleOptionInfo::isTime()
+ bool isTime() const { return bTime_; }
+ //! \copydoc DoubleOptionInfo::setScaleFactor()
+ void setScaleFactor(double factor);
private:
virtual void convertValue(const std::string &value);
virtual void processSetValues(ValueList *values);
- virtual void processAll();
- bool _bTime;
+ DoubleOptionInfo info_;
+ bool bTime_;
+ double factor_;
};
/*! \internal \brief
- * Converts, validates, and stores string values.
+ * Converts, validates, and stores floating-point (float) values.
*/
-class StringOptionStorage : public OptionStorageTemplate<std::string>
+class FloatOptionStorage : public OptionStorageTemplate<float>
{
public:
- //! \copydoc DoubleOptionStorage::DoubleOptionStorage()
- StringOptionStorage(const StringOption &settings, Options *options);
+ //! \copydoc IntegerOptionStorage::IntegerOptionStorage()
+ explicit FloatOptionStorage(const FloatOption &settings);
- virtual const char *typeString() const { return _allowed.empty() ? "string" : "enum"; }
- virtual std::string formatValue(int i) const;
+ virtual OptionInfo &optionInfo() { return info_; }
+ virtual std::string typeString() const;
+ virtual std::string formatSingleValue(const float &value) const;
+
+ //! \copydoc DoubleOptionStorage::isTime()
+ bool isTime() const { return bTime_; }
+ //! \copydoc DoubleOptionStorage::setScaleFactor()
+ void setScaleFactor(double factor);
private:
virtual void convertValue(const std::string &value);
- virtual void refreshValues();
+ virtual void processSetValues(ValueList *values);
- ValueList _allowed;
- int *_enumIndexStore;
+ FloatOptionInfo info_;
+ bool bTime_;
+ double factor_;
};
/*! \internal \brief
- * Converts, validates, and stores file names.
+ * Converts, validates, and stores string values.
*/
-class FileNameOptionStorage : public OptionStorageTemplate<std::string>
+class StringOptionStorage : public OptionStorageTemplate<std::string>
{
public:
- //! \copydoc StringOptionStorage::StringOptionStorage()
- FileNameOptionStorage(const FileNameOption &settings, Options *options);
+ //! \copydoc DoubleOptionStorage::DoubleOptionStorage()
+ explicit StringOptionStorage(const StringOption &settings);
+
+ virtual OptionInfo &optionInfo() { return info_; }
+ virtual std::string typeString() const
+ { return allowed_.empty() ? "string" : "enum"; }
+ virtual std::string formatExtraDescription() const;
+ virtual std::string formatSingleValue(const std::string &value) const;
- virtual const char *typeString() const { return "file"; }
- virtual std::string formatValue(int i) const;
+ //! \copydoc StringOptionInfo::allowedValues()
+ const ValueList &allowedValues() const { return allowed_; }
private:
virtual void convertValue(const std::string &value);
+ virtual void refreshValues();
+
+ void refreshEnumIndexStore();
- OptionFileType _filetype;
+ StringOptionInfo info_;
+ ValueList allowed_;
+ int *enumIndexStore_;
};
/*!\}*/