src/gromacs/analysisdata/datamodulemanager.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014,2015,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 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::AnalysisDataModuleManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_analysisdata
  42  */
  43 #ifndef GMX_ANALYSISDATA_DATAMODULEMANAGER_H
  44 #define GMX_ANALYSISDATA_DATAMODULEMANAGER_H
  45
  46 #include "gromacs/analysisdata/abstractdata.h"
  47 #include "gromacs/utility/classhelpers.h"
  48
  49 namespace gmx
  50 {
  51
  52 class AnalysisDataParallelOptions;
  53
  54 /*! \libinternal \brief
  55  * Encapsulates handling of data modules attached to AbstractAnalysisData.
  56  *
  57  * See IAnalysisDataModule and \ref module_analysisdata for more
  58  * details on the notifications and the order in which they should be raised.
  59  *
  60  * \inlibraryapi
  61  * \ingroup module_analysisdata
  62  */
  63 class AnalysisDataModuleManager
  64 {
  65 public:
  66     /*! \brief
  67      * Identifies data properties to check with data modules.
  68      *
  69      * \see IAnalysisDataModule::Flag
  70      */
  71     enum DataProperty
  72     {
  73         eMultipleDataSets, //!< Data has multiple data sets.
  74         eMultipleColumns,  //!< Data has multiple columns.
  75         eMultipoint,       //!< Data is multipoint.
  76         eDataPropertyNR    //!< Number of properties; for internal use only.
  77     };
  78
  79     AnalysisDataModuleManager();
  80     ~AnalysisDataModuleManager();
  81
  82     /*! \brief
  83      * Allows the manager to check modules for compatibility with the data.
  84      *
  85      * \throws  APIError if any data module already added is not compatible
  86      *      with the new setting.
  87      *
  88      * Does two things: checks any modules already attached to the data and
  89      * throws if any of them is not compatible, and stores the property
  90      * to check modules attached in the future.
  91      *
  92      * Strong exception safety.
  93      */
  94     void dataPropertyAboutToChange(DataProperty property, bool bSet);
  95
  96     /*! \brief
  97      * Whether there are modules that do not support parallel processing.
  98      *
  99      * Must not be called before notifyDataStart()/notifyParallelDataStart().
 100      * If notifyDataStart() has been called, returns true if there are any
 101      * modules (all modules are treated as serial).
 102      *
 103      * Does not throw.
 104      */
 105     bool hasSerialModules() const;
 106
 107     /*! \brief
 108      * Adds a module to process the data.
 109      *
 110      * \param     data    Data object to add the module to.
 111      * \param     module  Module to add.
 112      * \throws    std::bad_alloc if out of memory.
 113      * \throws    APIError if
 114      *      - \p module is not compatible with the data object
 115      *      - data has already been added to the data object and everything
 116      *        is not available through getDataFrame().
 117      * \throws    unspecified Any exception thrown by \p module in its
 118      *      notification methods (if data has been added).
 119      *
 120      * \see AbstractAnalysisData::addModule()
 121      */
 122     void addModule(AbstractAnalysisData* data, const AnalysisDataModulePointer& module);
 123     /*! \brief
 124      * Applies a module to process data that is ready.
 125      *
 126      * \param     data    Data object to apply the module to.
 127      * \param     module  Module to apply.
 128      * \throws    APIError in same situations as addModule().
 129      * \throws    unspecified Any exception thrown by \p module in its
 130      *      notification methods.
 131      *
 132      * \see AbstractAnalysisData::applyModule()
 133      */
 134     void applyModule(AbstractAnalysisData* data, IAnalysisDataModule* module);
 135
 136     /*! \brief
 137      * Notifies attached modules of the start of serial data.
 138      *
 139      * \param   data  Data object that is starting.
 140      * \throws  APIError if any attached data module is not compatible.
 141      * \throws  unspecified Any exception thrown by attached data modules
 142      *      in IAnalysisDataModule::dataStarted().
 143      *
 144      * Should be called once, after data properties have been set with
 145      * the methods in AbstractAnalysisData, and before any other
 146      * notification methods.
 147      * The caller should be prepared for requestStorage() calls to \p data
 148      * from the attached modules.
 149      *
 150      * \p data should typically be \c this when calling from a class
 151      * derived from AbstractAnalysisData.
 152      *
 153      * This method initializes all modules for serial processing by calling
 154      * IAnalysisDataModule::dataStarted().
 155      */
 156     void notifyDataStart(AbstractAnalysisData* data);
 157     /*! \brief
 158      * Notifies attached modules of the start of parallel data.
 159      *
 160      * \param     data    Data object that is starting.
 161      * \param[in] options Parallelization properties of the input data.
 162      * \throws  APIError if any attached data module is not compatible.
 163      * \throws  unspecified Any exception thrown by attached data modules
 164      *      in IAnalysisDataModule::parallelDataStarted().
 165      *
 166      * Can be called instead of notifyDataStart() if \p data supports
 167      * non-sequential creation of frames.  Works as notifyDataStart(),
 168      * but instead calls IAnalysisDataModule::parallelDataStarted()
 169      * and records whether the module supports the parallel mode.
 170      * Subsequent notification calls then notify the modules according to
 171      * the mode they accept.
 172      *
 173      * See notifyDataStart() for general constraints.
 174      */
 175     void notifyParallelDataStart(AbstractAnalysisData* data, const AnalysisDataParallelOptions& options);
 176     /*! \brief
 177      * Notifies attached serial modules of the start of a frame.
 178      *
 179      * \param[in] header  Header information for the frame that is starting.
 180      * \throws    unspecified Any exception thrown by attached data modules
 181      *      in IAnalysisDataModule::frameStarted().
 182      *
 183      * Should be called once for each frame, before notifyPointsAdd() calls
 184      * for that frame.
 185      */
 186     void notifyFrameStart(const AnalysisDataFrameHeader& header) const;
 187     /*! \brief
 188      * Notifies attached parallel modules of the start of a frame.
 189      *
 190      * \param[in] header  Header information for the frame that is starting.
 191      * \throws    unspecified Any exception thrown by attached data modules
 192      *      in IAnalysisDataModule::frameStarted().
 193      *
 194      * If notifyParallelDataStart() has been called, should be called once
 195      * for each frame, before notifyParallelPointsAdd() calls for that
 196      * frame.
 197      * It is allowed to call this method in any order for the frames, but
 198      * should be called exactly once for each frame.
 199      */
 200     void notifyParallelFrameStart(const AnalysisDataFrameHeader& header) const;
 201     /*! \brief
 202      * Notifies attached serial modules of the addition of points to the
 203      * current frame.
 204      *
 205      * \param[in] points  Set of points added (also provides access to
 206      *      frame-level data).
 207      * \throws    APIError if any attached data module is not compatible.
 208      * \throws    unspecified Any exception thrown by attached data modules
 209      *      in IAnalysisDataModule::pointsAdded().
 210      *
 211      * Can be called zero or more times for each frame.
 212      * The caller should ensure that any column occurs at most once in the
 213      * calls, unless the data is multipoint.
 214      * For efficiency reasons, calls to this method should be aggregated
 215      * whenever possible, i.e., it's better to handle multiple columns or
 216      * even the whole frame in a single call rather than calling the method
 217      * for each column separately.
 218      */
 219     void notifyPointsAdd(const AnalysisDataPointSetRef& points) const;
 220     /*! \brief
 221      * Notifies attached parallel modules of the addition of points to a frame.
 222      *
 223      * \param[in] points  Set of points added (also provides access to
 224      *      frame-level data).
 225      * \throws    APIError if any attached data module is not compatible.
 226      * \throws    unspecified Any exception thrown by attached data modules
 227      *      in IAnalysisDataModule::pointsAdded().
 228      *
 229      * See notifyPointsAdd() for information on the structure of the point
 230      * sets.
 231      */
 232     void notifyParallelPointsAdd(const AnalysisDataPointSetRef& points) const;
 233     /*! \brief
 234      * Notifies attached serial modules of the end of a frame.
 235      *
 236      * \param[in] header  Header information for the frame that is ending.
 237      * \throws    unspecified Any exception thrown by attached data modules
 238      *      in IAnalysisDataModule::frameFinished().
 239      *
 240      * Should be called once for each call of notifyFrameStart(), after any
 241      * notifyPointsAdd() calls for the frame.
 242      * \p header should be identical to that used in the corresponding
 243      * notifyFrameStart() call.
 244      *
 245      * This method also notifies parallel modules about serial end of frame.
 246      */
 247     void notifyFrameFinish(const AnalysisDataFrameHeader& header) const;
 248     /*! \brief
 249      * Notifies attached parallel modules of the end of a frame.
 250      *
 251      * \param[in] header  Header information for the frame that is ending.
 252      * \throws    unspecified Any exception thrown by attached data modules
 253      *      in IAnalysisDataModule::frameFinished().
 254      *
 255      * Should be called once for each call of notifyParallelFrameStart(),
 256      * after any notifyParallelPointsAdd() calls for the frame.
 257      * \p header should be identical to that used in the corresponding
 258      * notifyParallelFrameStart() call.
 259      */
 260     void notifyParallelFrameFinish(const AnalysisDataFrameHeader& header) const;
 261     /*! \brief
 262      * Notifies attached modules of the end of data.
 263      *
 264      * \throws    unspecified Any exception thrown by attached data modules
 265      *      in IAnalysisDataModule::dataFinished().
 266      *
 267      * Should be called once, after all the other notification calls.
 268      */
 269     void notifyDataFinish() const;
 270
 271 private:
 272     class Impl;
 273
 274     PrivateImplPointer<Impl> impl_;
 275 };
 276
 277 } // namespace gmx
 278
 279 #endif