src/gromacs/options/behaviorcollection.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2018, 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::OptionsBehaviorCollection.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_options
  42  */
  43 #ifndef GMX_OPTIONS_BEHAVIORCOLLECTION_H
  44 #define GMX_OPTIONS_BEHAVIORCOLLECTION_H
  45
  46 #include <memory>
  47 #include <vector>
  48
  49 #include "gromacs/utility/classhelpers.h"
  50
  51 namespace gmx
  52 {
  53
  54 class IOptionsBehavior;
  55 class Options;
  56
  57 //! Smart pointer for behaviors stored in OptionsBehaviorCollection.
  58 typedef std::shared_ptr<IOptionsBehavior> OptionsBehaviorPointer;
  59
  60 /*! \libinternal \brief
  61  * Container for IOptionsBehavior objects.
  62  *
  63  * This class provides a container to keep IOptionsBehavior objects, and to
  64  * call the IOptionsBehavior methods for the contained objects.
  65  *
  66  * IOptionsBehavior methods are called for the contained objects in the same
  67  * order as in which the behaviors were inserted.
  68  *
  69  * \inlibraryapi
  70  * \ingroup module_options
  71  */
  72 class OptionsBehaviorCollection
  73 {
  74     public:
  75         /*! \brief
  76          * Constructs a container for storing behaviors associated with given
  77          * Options.
  78          *
  79          * Caller needs to ensure that provided Options remains in existence
  80          * while the container exists.
  81          */
  82         explicit OptionsBehaviorCollection(Options *options);
  83         ~OptionsBehaviorCollection();
  84
  85         //! Adds a behavior to the collection.
  86         void addBehavior(const OptionsBehaviorPointer &behavior);
  87         //! Calls IOptionsBehavior::optionsFinishing() on all behaviors.
  88         void optionsFinishing();
  89         //! Calls IOptionsBehavior::optionsFinished() on all behaviors.
  90         void optionsFinished();
  91
  92     private:
  93         Options                             *options_;
  94         std::vector<OptionsBehaviorPointer>  behaviors_;
  95
  96         GMX_DISALLOW_COPY_AND_ASSIGN(OptionsBehaviorCollection);
  97 };
  98
  99 }  // namespace gmx
 100
 101 #endif