src/gromacs/analysisdata/datamodule.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,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 /*! \file
  36  * \brief
  37  * Declares gmx::AnalysisDataModuleInterface and related convenience classes.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_analysisdata
  42  */
  43 #ifndef GMX_ANALYSISDATA_DATAMODULE_H
  44 #define GMX_ANALYSISDATA_DATAMODULE_H
  45
  46 namespace gmx
  47 {
  48
  49 class AbstractAnalysisData;
  50 class AnalysisDataFrameHeader;
  51 class AnalysisDataParallelOptions;
  52 class AnalysisDataPointSetRef;
  53
  54 /*! \brief
  55  * Interface for a module that gets notified whenever data is added.
  56  *
  57  * The interface provides one method (flags()) that describes features of
  58  * data objects the module supports.  Only most common features are included
  59  * in the flags; custom checks can be implemented in the dataStarted() and/or
  60  * parallelDataStarted() methods (see below).
  61  * All other methods in the interface are callbacks that are called by the
  62  * data object to which the module is attached to describe the data.
  63  *
  64  * The modules can operate in two modes: serial or parallel.
  65  * In serial mode, the frames are presented to the module always in the order
  66  * of increasing indices, even if they become ready in a different order in the
  67  * attached data.
  68  * In parallel mode, the frames are presented in the order that they become
  69  * available in the input data, which may not be sequential.  This mode allows
  70  * the input data to optimize its behavior if it does not need to store and
  71  * sort the frames.
  72  * If the input data supports parallel mode, it calls parallelDataStarted().
  73  * If the module returns true from this method, then it will process the frames
  74  * in the parallel mode.  If the module returns false, it will get the frames
  75  * in serial order.
  76  * If the input data does not support parallel mode, it calls dataStarted().
  77  *
  78  * Concrete modules typically do not directly derive from this interface, but
  79  * from either AnalysisDataModuleSerial or AnalysisDataModuleParallel.
  80  * Both these classes implement one of dataStarted()/parallelDataStarted() by
  81  * forwarding the calls to the other method of this pair.  This allows the
  82  * module to only implement the initialization once, without needing to worry
  83  * how to correctly handle both cases.
  84  *
  85  * Currently, if the module throws an exception, it requires the analysis tool
  86  * to terminate, since AbstractAnalysisData will be left in a state where it
  87  * is not possible to continue processing.  See a related todo item in
  88  * AbstractAnalysisData.
  89  *
  90  * \inlibraryapi
  91  * \ingroup module_analysisdata
  92  */
  93 class AnalysisDataModuleInterface
  94 {
  95     public:
  96         /*! \brief
  97          * Possible flags for flags().
  98          */
  99         enum Flag
 100         {
 101             //! The module can process multipoint data.
 102             efAllowMultipoint           = 1<<0,
 103             //! The module does not make sense for non-multipoint data.
 104             efOnlyMultipoint            = 1<<1,
 105             //! The module can process data with more than one column.
 106             efAllowMulticolumn          = 1<<2,
 107             //! The module can process data with missing points.
 108             efAllowMissing              = 1<<3,
 109             //! The module can process data with multiple data sets.
 110             efAllowMultipleDataSets     = 1<<4
 111         };
 112
 113         virtual ~AnalysisDataModuleInterface() {};
 114
 115         /*! \brief
 116          * Returns properties supported by the module.
 117          *
 118          * The return value of this method should not change after the module
 119          * has been added to a data (this responsibility can, and in most cases
 120          * must, be delegated to the user of the module).
 121          *
 122          * The purpose of this method is to remove the need for common checks
 123          * for data compatibility in the classes that implement the interface.
 124          * Instead, AbstractAnalysisData performs these checks based on the
 125          * flags provided.
 126          *
 127          * Does not throw.
 128          */
 129         virtual int flags() const = 0;
 130
 131         /*! \brief
 132          * Called (once) when the data has been set up properly.
 133          *
 134          * \param[in] data  Data object to which the module is added.
 135          * \throws    APIError if the provided data is not compatible.
 136          * \throws    unspecified  Can throw any exception required by the
 137          *      implementing class to report errors.
 138          *
 139          * When the data is ready, either this method or parallelDataStarted()
 140          * is called, depending on the nature of the input data.  If this
 141          * method is called, the input data will always present the frames in
 142          * sequential order.
 143          *
 144          * The data to which the module is attached is passed as an argument
 145          * to provide access to properties of the data for initialization
 146          * and/or validation.  The module can also call
 147          * AbstractAnalysisData::requestStorage() if needed.
 148          *
 149          * This is the only place where the module gets access to the data;
 150          * if properties of the data are required later, the module should
 151          * store them internally.  It is guaranteed that the data properties
 152          * (column count, whether it's multipoint) do not change once this
 153          * method has been called.
 154          *
 155          * Notice that \p data will be a proxy object if the module is added as
 156          * a column module, not the data object for which
 157          * AbstractAnalysisData::addColumnModule() was called.
 158          */
 159         virtual void dataStarted(AbstractAnalysisData *data) = 0;
 160         /*! \brief
 161          * Called (once) for parallel data when the data has been set up.
 162          *
 163          * \param[in] data     Data object to which the module is added.
 164          * \param[in] options  Parallelization properties of the input data.
 165          * \returns   true if the module can process the input in
 166          *      non-sequential order.
 167          * \throws    APIError if the provided data is not compatible.
 168          * \throws    unspecified  Can throw any exception required by the
 169          *      implementing class to report errors.
 170          *
 171          * This method is called instead of dataStarted() if the input data has
 172          * the capability to present data in non-sequential order.
 173          * If the method returns true, then the module accepts this and frame
 174          * notification methods may be called in that non-sequential order.
 175          * If the method returns false, then the frame notification methods are
 176          * called in sequential order, as if dataStarted() had been called.
 177          *
 178          * See dataStarted() for general information on initializing the data.
 179          * That applies to this method as well, with the exception that calling
 180          * AbstractAnalysisData::requestStorage() is currently not very well
 181          * supported (or rather, accessing the requested storage doesn't work).
 182          */
 183         virtual bool parallelDataStarted(
 184             AbstractAnalysisData              *data,
 185             const AnalysisDataParallelOptions &options) = 0;
 186         /*! \brief
 187          * Called at the start of each data frame.
 188          *
 189          * \param[in] frame  Header information for the frame that is starting.
 190          * \throws    unspecified  Can throw any exception required by the
 191          *      implementing class to report errors.
 192          */
 193         virtual void frameStarted(const AnalysisDataFrameHeader &frame) = 0;
 194         /*! \brief
 195          * Called one or more times during each data frame.
 196          *
 197          * \param[in] points  Set of points added (also provides access to
 198          *      frame-level data).
 199          * \throws    APIError if the provided data is not compatible.
 200          * \throws    unspecified  Can throw any exception required by the
 201          *      implementing class to report errors.
 202          *
 203          * Can be called once or multiple times for a frame.  For all data
 204          * objects currently implemented in the library (and all objects that
 205          * will use AnalysisDataStorage for internal implementation), it is
 206          * called exactly once for each frame if the data is not multipoint,
 207          * but currently this restriction is not enforced.
 208          */
 209         virtual void pointsAdded(const AnalysisDataPointSetRef &points) = 0;
 210         /*! \brief
 211          * Called when a data frame is finished.
 212          *
 213          * \param[in] header  Header information for the frame that is ending.
 214          * \throws    unspecified  Can throw any exception required by the
 215          *      implementing class to report errors.
 216          */
 217         virtual void frameFinished(const AnalysisDataFrameHeader &header) = 0;
 218         /*! \brief
 219          * Called (once) when no more data is available.
 220          *
 221          * \throws    unspecified  Can throw any exception required by the
 222          *      implementing class to report errors.
 223          */
 224         virtual void dataFinished() = 0;
 225 };
 226
 227 /*! \brief
 228  * Convenience base class for serial analysis data modules.
 229  *
 230  * Implements the parallelDataStarted() method such that initialization is
 231  * always forwarded to dataStarted(), and the module always behaves as serial
 232  * (parallelDataStarted() returns false).
 233  *
 234  * \inlibraryapi
 235  * \ingroup module_analysisdata
 236  */
 237 class AnalysisDataModuleSerial : public AnalysisDataModuleInterface
 238 {
 239     public:
 240         virtual ~AnalysisDataModuleSerial() {}
 241
 242         virtual int flags() const = 0;
 243
 244         virtual void dataStarted(AbstractAnalysisData *data)              = 0;
 245         virtual void frameStarted(const AnalysisDataFrameHeader &frame)   = 0;
 246         virtual void pointsAdded(const AnalysisDataPointSetRef &points)   = 0;
 247         virtual void frameFinished(const AnalysisDataFrameHeader &header) = 0;
 248         virtual void dataFinished() = 0;
 249
 250     private:
 251         virtual bool parallelDataStarted(
 252             AbstractAnalysisData              *data,
 253             const AnalysisDataParallelOptions &options);
 254 };
 255
 256 /*! \brief
 257  * Convenience base class for parallel analysis data modules.
 258  *
 259  * Implements the dataStarted() method such that initialization is always done
 260  * in parallelDataStarted().  dataStarted() calls are forwarded to
 261  * parallelDataStarted() using a dummy serial AnalysisDataParallelOptions.
 262  *
 263  * \inlibraryapi
 264  * \ingroup module_analysisdata
 265  */
 266 class AnalysisDataModuleParallel : public AnalysisDataModuleInterface
 267 {
 268     public:
 269         virtual ~AnalysisDataModuleParallel() {}
 270
 271         virtual int flags() const = 0;
 272
 273         virtual bool parallelDataStarted(
 274             AbstractAnalysisData              *data,
 275             const AnalysisDataParallelOptions &options)                   = 0;
 276         virtual void frameStarted(const AnalysisDataFrameHeader &frame)   = 0;
 277         virtual void pointsAdded(const AnalysisDataPointSetRef &points)   = 0;
 278         virtual void frameFinished(const AnalysisDataFrameHeader &header) = 0;
 279         virtual void dataFinished() = 0;
 280
 281     private:
 282         virtual void dataStarted(AbstractAnalysisData *data);
 283 };
 284
 285 } // namespace gmx
 286
 287 #endif