Sort all includes in src/gromacs
[alexxy/gromacs.git] / src / gromacs / options / optionstoragetemplate.h
index e6f79c24a1e88dab019cb7761eb41b486c1d3fd1..ad00611d04e2822af2235c2b67f8666f4c4cb44a 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.
  */
 /*! \libinternal \file
  * \brief
  * Defines gmx::OptionStorageTemplate template.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \inlibraryapi
  * \ingroup module_options
  */
 
 #include <boost/scoped_ptr.hpp>
 
-#include "../utility/exceptions.h"
-#include "../utility/gmxassert.h"
-
-#include "abstractoption.h"
-#include "abstractoptionstorage.h"
+#include "gromacs/options/abstractoption.h"
+#include "gromacs/options/abstractoptionstorage.h"
+#include "gromacs/utility/common.h"
+#include "gromacs/utility/exceptions.h"
+#include "gromacs/utility/gmxassert.h"
 
 namespace gmx
 {
@@ -92,7 +96,7 @@ class OptionStorageTemplate : public AbstractOptionStorage
 
         // No implementation in this class for the pure virtual methods, but
         // the declarations are still included for clarity.
-        virtual const char *typeString() const = 0;
+        virtual std::string typeString() const = 0;
         virtual int valueCount() const { return static_cast<int>(values_->size()); }
         /*! \copydoc gmx::AbstractOptionStorage::formatValue()
          *
@@ -118,7 +122,7 @@ class OptionStorageTemplate : public AbstractOptionStorage
 
 
         virtual void clearSet();
-        /*! \copydoc AbstractOptionStorage::convertValue()
+        /*! \copydoc gmx::AbstractOptionStorage::convertValue()
          *
          * Derived classes should call addValue() after they have converted
          * \p value to the storage type.  It is allowed to call addValue()
@@ -142,8 +146,9 @@ class OptionStorageTemplate : public AbstractOptionStorage
          */
         virtual void processSetValues(ValueList *values)
         {
+            GMX_UNUSED_VALUE(values);
         }
-        /*! \copydoc AbstractOptionStorage::processSet()
+        /*! \copydoc gmx::AbstractOptionStorage::processSet()
          *
          * OptionStorageTemplate implements transaction support for a set of
          * values in this method (see the class description), and provides a
@@ -153,7 +158,7 @@ class OptionStorageTemplate : public AbstractOptionStorage
          * necessary.
          */
         virtual void processSet();
-        /*! \copydoc AbstractOptionStorage::processAll()
+        /*! \copydoc gmx::AbstractOptionStorage::processAll()
          *
          * The implementation in OptionStorageTemplate does nothing.
          */
@@ -255,7 +260,7 @@ class OptionStorageTemplate : public AbstractOptionStorage
          * derived classes if necessary, and refreshValues() should be called
          * if any changes are made.
          */
-        ValueList &values() { return *values_; }
+        ValueList       &values() { return *values_; }
         //! Provides derived classes access to the current list of values.
         const ValueList &values() const { return *values_; }
 
@@ -275,11 +280,11 @@ class OptionStorageTemplate : public AbstractOptionStorage
          * and other storage locations are updated only when refreshValues() is
          * called.
          */
-        ValueList              *values_;
-        T                      *store_;
-        int                    *countptr_;
+        ValueList                   *values_;
+        T                           *store_;
+        int                         *countptr_;
         boost::scoped_ptr<ValueList> ownedValues_;
-        boost::scoped_ptr<T>    defaultValueIfSet_;
+        boost::scoped_ptr<T>         defaultValueIfSet_;
 
         // Copy and assign disallowed by base.
 };
@@ -327,7 +332,7 @@ OptionStorageTemplate<T>::OptionStorageTemplate(const OptionTemplate<T, U> &sett
         {
             values_->clear();
             int count = (settings.isVector() ?
-                            settings.maxValueCount_ : settings.minValueCount_);
+                         settings.maxValueCount_ : settings.minValueCount_);
             for (int i = 0; i < count; ++i)
             {
                 values_->push_back(store_[i]);
@@ -469,6 +474,7 @@ void OptionStorageTemplate<T>::setDefaultValueIfSet(const T &value)
     {
         GMX_THROW(APIError("defaultValueIfSet() is not supported with allowMultiple()"));
     }
+    setFlag(efOption_DefaultValueIfSetExists);
     defaultValueIfSet_.reset(new T(value));
 }