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, 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 "abstractdata.h"
  47
  48 #include "../utility/common.h"
  49
  50 namespace gmx
  51 {
  52
  53 class AnalysisDataParallelOptions;
  54
  55 /*! \libinternal \brief
  56  * Encapsulates handling of data modules attached to AbstractAnalysisData.
  57  *
  58  * \inlibraryapi
  59  * \ingroup module_analysisdata
  60  */
  61 class AnalysisDataModuleManager
  62 {
  63     public:
  64         /*! \brief
  65          * Identifies data properties to check with data modules.
  66          *
  67          * \see AnalysisDataModuleInterface::Flag
  68          */
  69         enum DataProperty
  70         {
  71             eMultipleDataSets, //!< Data has multiple data sets.
  72             eMultipleColumns,  //!< Data has multiple columns.
  73             eMultipoint,       //!< Data is multipoint.
  74             eDataPropertyNR    //!< Number of properties; for internal use only.
  75         };
  76
  77         AnalysisDataModuleManager();
  78         ~AnalysisDataModuleManager();
  79
  80         /*! \brief
  81          * Allows the manager to check modules for compatibility with the data.
  82          *
  83          * \throws  APIError if any data module already added is not compatible
  84          *      with the new setting.
  85          *
  86          * Does two things: checks any modules already attached to the data and
  87          * throws if any of them is not compatible, and stores the property
  88          * to check modules attached in the future.
  89          *
  90          * Strong exception safety.
  91          */
  92         void dataPropertyAboutToChange(DataProperty property, bool bSet);
  93
  94         /*! \brief
  95          * Whether there are modules that do not support parallel processing.
  96          *
  97          * Must not be called before notifyDataStart()/notifyParallelDataStart().
  98          * If notifyDataStart() has been called, returns true if there are any
  99          * modules (all modules are treated as serial).
 100          *
 101          * Does not throw.
 102          */
 103         bool hasSerialModules() const;
 104
 105         /*! \brief
 106          * Adds a module to process the data.
 107          *
 108          * \param     data    Data object to add the module to.
 109          * \param     module  Module to add.
 110          * \throws    std::bad_alloc if out of memory.
 111          * \throws    APIError if
 112          *      - \p module is not compatible with the data object
 113          *      - data has already been added to the data object and everything
 114          *        is not available through getDataFrame().
 115          * \throws    unspecified Any exception thrown by \p module in its
 116          *      notification methods (if data has been added).
 117          *
 118          * \see AbstractAnalysisData::addModule()
 119          */
 120         void addModule(AbstractAnalysisData      *data,
 121                        AnalysisDataModulePointer  module);
 122         /*! \brief
 123          * Applies a module to process data that is ready.
 124          *
 125          * \param     data    Data object to apply the module to.
 126          * \param     module  Module to apply.
 127          * \throws    APIError in same situations as addModule().
 128          * \throws    unspecified Any exception thrown by \p module in its
 129          *      notification methods.
 130          *
 131          * \see AbstractAnalysisData::applyModule()
 132          */
 133         void applyModule(AbstractAnalysisData        *data,
 134                          AnalysisDataModuleInterface *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 AnalysisDataModuleInterface::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          * AnalysisDataModuleInterface::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 AnalysisDataModuleInterface::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 AnalysisDataModuleInterface::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(
 176             AbstractAnalysisData              *data,
 177             const AnalysisDataParallelOptions &options);
 178         /*! \brief
 179          * Notifies attached serial modules of the start of a frame.
 180          *
 181          * \param[in] header  Header information for the frame that is starting.
 182          * \throws    unspecified Any exception thrown by attached data modules
 183          *      in AnalysisDataModuleInterface::frameStarted().
 184          *
 185          * Should be called once for each frame, before notifyPointsAdd() calls
 186          * for that frame.
 187          */
 188         void notifyFrameStart(const AnalysisDataFrameHeader &header) const;
 189         /*! \brief
 190          * Notifies attached parallel modules of the start of a frame.
 191          *
 192          * \param[in] header  Header information for the frame that is starting.
 193          * \throws    unspecified Any exception thrown by attached data modules
 194          *      in AnalysisDataModuleInterface::frameStarted().
 195          *
 196          * If notifyParallelDataStart() has been called, should be called once
 197          * for each frame, before notifyParallelPointsAdd() calls for that
 198          * frame.
 199          * It is allowed to call this method in any order for the frames, but
 200          * should be called exactly once for each frame.
 201          */
 202         void notifyParallelFrameStart(const AnalysisDataFrameHeader &header) const;
 203         /*! \brief
 204          * Notifies attached serial modules of the addition of points to the
 205          * current frame.
 206          *
 207          * \param[in] points  Set of points added (also provides access to
 208          *      frame-level data).
 209          * \throws    APIError if any attached data module is not compatible.
 210          * \throws    unspecified Any exception thrown by attached data modules
 211          *      in AnalysisDataModuleInterface::pointsAdded().
 212          *
 213          * Can be called zero or more times for each frame.
 214          * The caller should ensure that any column occurs at most once in the
 215          * calls, unless the data is multipoint.
 216          * For efficiency reasons, calls to this method should be aggregated
 217          * whenever possible, i.e., it's better to handle multiple columns or
 218          * even the whole frame in a single call rather than calling the method
 219          * for each column separately.
 220          */
 221         void notifyPointsAdd(const AnalysisDataPointSetRef &points) const;
 222         /*! \brief
 223          * Notifies attached parallel modules of the addition of points to a frame.
 224          *
 225          * \param[in] points  Set of points added (also provides access to
 226          *      frame-level data).
 227          * \throws    APIError if any attached data module is not compatible.
 228          * \throws    unspecified Any exception thrown by attached data modules
 229          *      in AnalysisDataModuleInterface::pointsAdded().
 230          *
 231          * See notifyPointsAdd() for information on the structure of the point
 232          * sets.
 233          */
 234         void notifyParallelPointsAdd(const AnalysisDataPointSetRef &points) const;
 235         /*! \brief
 236          * Notifies attached serial modules of the end of a frame.
 237          *
 238          * \param[in] header  Header information for the frame that is ending.
 239          * \throws    unspecified Any exception thrown by attached data modules
 240          *      in AnalysisDataModuleInterface::frameFinished().
 241          *
 242          * Should be called once for each call of notifyFrameStart(), after any
 243          * notifyPointsAdd() calls for the frame.
 244          * \p header should be identical to that used in the corresponding
 245          * notifyFrameStart() call.
 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 AnalysisDataModuleInterface::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 AnalysisDataModuleInterface::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