Sort all includes in src/gromacs
[alexxy/gromacs.git] / src / gromacs / options / basicoptionstorage.h
index 8438135f5bfa1a7aa23c2540ee06e54ede91991b..59ab9f16fc86a54925b935acb11a22348eb1d578 100644 (file)
@@ -1,38 +1,42 @@
 /*
+ * 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 "basicoptions.h"
-#include "basicoptioninfo.h"
-#include "optionstoragetemplate.h"
+#include "gromacs/options/basicoptions.h"
+#include "gromacs/options/optionstoragetemplate.h"
 
 namespace gmx
 {
 
-class BooleanOption;
-class IntegerOption;
-class DoubleOption;
-class StringOption;
-
 /*! \addtogroup module_options
  * \{
  */
@@ -74,9 +72,12 @@ class BooleanOptionStorage : public OptionStorageTemplate<bool>
         }
 
         virtual OptionInfo &optionInfo() { return info_; }
-        virtual const char *typeString() const { return "bool"; }
+        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);
 
@@ -96,7 +97,7 @@ class IntegerOptionStorage : public OptionStorageTemplate<int>
         }
 
         virtual OptionInfo &optionInfo() { return info_; }
-        virtual const char *typeString() const
+        virtual std::string typeString() const
         { return isVector() ? "vector" : "int"; }
         virtual std::string formatSingleValue(const int &value) const;
 
@@ -107,6 +108,28 @@ class IntegerOptionStorage : public OptionStorageTemplate<int>
         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
  * Converts, validates, and stores floating-point (double) values.
  */
@@ -117,7 +140,7 @@ class DoubleOptionStorage : public OptionStorageTemplate<double>
         explicit DoubleOptionStorage(const DoubleOption &settings);
 
         virtual OptionInfo &optionInfo() { return info_; }
-        virtual const char *typeString() const;
+        virtual std::string typeString() const;
         virtual std::string formatSingleValue(const double &value) const;
 
         //! \copydoc DoubleOptionInfo::isTime()
@@ -128,13 +151,39 @@ class DoubleOptionStorage : public OptionStorageTemplate<double>
     private:
         virtual void convertValue(const std::string &value);
         virtual void processSetValues(ValueList *values);
-        virtual void processAll();
 
         DoubleOptionInfo        info_;
         bool                    bTime_;
         double                  factor_;
 };
 
+/*! \internal \brief
+ * Converts, validates, and stores floating-point (float) values.
+ */
+class FloatOptionStorage : public OptionStorageTemplate<float>
+{
+    public:
+        //! \copydoc IntegerOptionStorage::IntegerOptionStorage()
+        explicit FloatOptionStorage(const FloatOption &settings);
+
+        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 processSetValues(ValueList *values);
+
+        FloatOptionInfo         info_;
+        bool                    bTime_;
+        double                  factor_;
+};
+
 /*! \internal \brief
  * Converts, validates, and stores string values.
  */
@@ -145,13 +194,20 @@ class StringOptionStorage : public OptionStorageTemplate<std::string>
         explicit StringOptionStorage(const StringOption &settings);
 
         virtual OptionInfo &optionInfo() { return info_; }
-        virtual const char *typeString() const { return allowed_.empty() ? "string" : "enum"; }
+        virtual std::string typeString() const
+        { return allowed_.empty() ? "string" : "enum"; }
+        virtual std::string formatExtraDescription() const;
         virtual std::string formatSingleValue(const std::string &value) const;
 
+        //! \copydoc StringOptionInfo::allowedValues()
+        const ValueList &allowedValues() const { return allowed_; }
+
     private:
         virtual void convertValue(const std::string &value);
         virtual void refreshValues();
 
+        void refreshEnumIndexStore();
+
         StringOptionInfo        info_;
         ValueList               allowed_;
         int                    *enumIndexStore_;