src/gromacs/options/optionmanagercontainer.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::OptionManagerContainer.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_options
  42  */
  43 #ifndef GMX_OPTIONS_OPTIONMANAGERCONTAINER_H
  44 #define GMX_OPTIONS_OPTIONMANAGERCONTAINER_H
  45
  46 #include <vector>
  47
  48 #include "gromacs/utility/common.h"
  49 #include "gromacs/utility/gmxassert.h"
  50
  51 namespace gmx
  52 {
  53
  54 class OptionManagerInterface;
  55
  56 /*! \libinternal
  57  * \brief
  58  * Container to keep managers added with Options::addManager() and pass them
  59  * to options.
  60  *
  61  * Consistency of the managers (e.g., that there is at most one manager of a
  62  * certain type) is only checked when the managers are accessed.
  63  *
  64  * \inlibraryapi
  65  * \ingroup module_options
  66  */
  67 class OptionManagerContainer
  68 {
  69     public:
  70         OptionManagerContainer()
  71         {
  72         }
  73
  74         //! Returns `true` if there are no managers.
  75         bool empty() const { return list_.empty(); }
  76
  77         //! Adds a manager to the container.
  78         void add(OptionManagerInterface *manager)
  79         {
  80             list_.push_back(manager);
  81         }
  82         /*! \brief
  83          * Retrieves a manager of a certain type.
  84          *
  85          * \tparam  ManagerType  Type of manager to retrieve
  86          *     (should derive from OptionManagerInterface).
  87          * \returns The manager, or `NULL` if there is none.
  88          *
  89          * This method is used in AbstractOption::createStorage() to retrieve
  90          * a manager of a certain type for options that use a manager.
  91          *
  92          * The return value is `NULL` if there is no manager of the given type.
  93          * The caller needs to handle this (either by asserting, or by handling
  94          * the manager as optional).
  95          */
  96         template <class ManagerType>
  97         ManagerType *get() const
  98         {
  99             ManagerType *result = NULL;
 100             for (ListType::const_iterator i = list_.begin(); i != list_.end(); ++i)
 101             {
 102                 ManagerType *curr = dynamic_cast<ManagerType *>(*i);
 103                 if (curr != NULL)
 104                 {
 105                     GMX_RELEASE_ASSERT(result == NULL,
 106                                        "More than one applicable option manager is set");
 107                     result = curr;
 108                 }
 109             }
 110             return result;
 111         }
 112
 113     private:
 114         //! Shorthand for the internal container type.
 115         typedef std::vector<OptionManagerInterface *> ListType;
 116
 117         ListType  list_;
 118
 119         GMX_DISALLOW_COPY_AND_ASSIGN(OptionManagerContainer);
 120 };
 121
 122 } // namespace gmx
 123
 124 #endif