/*
+ * 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
{
// 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()
*
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()
*/
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
* necessary.
*/
virtual void processSet();
- /*! \copydoc AbstractOptionStorage::processAll()
+ /*! \copydoc gmx::AbstractOptionStorage::processAll()
*
* The implementation in OptionStorageTemplate does nothing.
*/
*/
virtual void refreshValues();
+ /*! \brief
+ * Sets the default value for the option.
+ *
+ * \param[in] value Default value to set.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * This method can be used from the derived class constructor to
+ * programmatically set a default value.
+ */
+ void setDefaultValue(const T &value);
+ /*! \brief
+ * Sets the default value if set for the option.
+ *
+ * \param[in] value Default value to set.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * This method can be used from the derived class constructor to
+ * programmatically set a default value.
+ */
+ void setDefaultValueIfSet(const T &value);
+
/*! \brief
* Provides derived classes access to the current list of values.
*
* 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_; }
* 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.
};
setFlag(efOption_HasDefaultValue);
if (settings.defaultValue_ != NULL)
{
- values_->clear();
- addValue(*settings.defaultValue_);
- // TODO: This is a bit hairy, as it indirectly calls a virtual function.
- commitValues();
+ setDefaultValue(*settings.defaultValue_);
}
else if (ownedValues_.get() != NULL && store_ != NULL)
{
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]);
}
if (settings.defaultValueIfSet_ != NULL)
{
- if (hasFlag(efOption_MultipleTimes))
- {
- GMX_THROW(APIError("defaultValueIfSet() is not supported with allowMultiple()"));
- }
- defaultValueIfSet_.reset(new T(*settings.defaultValueIfSet_));
+ setDefaultValueIfSet(*settings.defaultValueIfSet_);
}
}
}
}
}
+
+template <typename T>
+void OptionStorageTemplate<T>::setDefaultValue(const T &value)
+{
+ if (hasFlag(efOption_NoDefaultValue))
+ {
+ GMX_THROW(APIError("Option does not support default value, but one is set"));
+ }
+ if (hasFlag(efOption_HasDefaultValue))
+ {
+ setFlag(efOption_ExplicitDefaultValue);
+ clear();
+ clearSet();
+ addValue(value);
+ // TODO: As this is called from the constructor, it should not call
+ // virtual functions.
+ commitValues();
+ }
+}
+
+
+template <typename T>
+void OptionStorageTemplate<T>::setDefaultValueIfSet(const T &value)
+{
+ if (hasFlag(efOption_NoDefaultValue))
+ {
+ GMX_THROW(APIError("Option does not support default value, but one is set"));
+ }
+ if (hasFlag(efOption_MultipleTimes))
+ {
+ GMX_THROW(APIError("defaultValueIfSet() is not supported with allowMultiple()"));
+ }
+ setFlag(efOption_DefaultValueIfSetExists);
+ defaultValueIfSet_.reset(new T(value));
+}
+
} // namespace gmx
#endif
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff