src/gromacs/options/ivaluestore.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \file
  36  * \brief
  37  * Declares gmx::IOptionValueStore.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #ifndef GMX_OPTIONS_IVALUESTORE_H
  43 #define GMX_OPTIONS_IVALUESTORE_H
  44
  45 namespace gmx
  46 {
  47
  48 template<typename T>
  49 class ArrayRef;
  50
  51 /*! \internal
  52  * \brief
  53  * Represents the final storage location of option values.
  54  *
  55  * \todo
  56  * Try to make this more like a write-only interface, getting rid of the need
  57  * to access the stored values through this interface.  That would simplify
  58  * things.
  59  *
  60  * \ingroup module_options
  61  */
  62 template<typename T>
  63 class IOptionValueStore
  64 {
  65 public:
  66     virtual ~IOptionValueStore() {}
  67
  68     //! Returns the number of values stored so far.
  69     virtual int valueCount() = 0;
  70     //! Returns a reference to the actual values.
  71     virtual ArrayRef<T> values() = 0;
  72     //! Removes all stored values.
  73     virtual void clear() = 0;
  74     //! Reserves memory for additional `count` entries.
  75     virtual void reserve(size_t count) = 0;
  76     //! Appends a value to the store.
  77     virtual void append(const T& value) = 0;
  78 };
  79
  80 } // namespace gmx
  81
  82 #endif