src/gromacs/analysisdata/dataproxy.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Declares gmx::AnalysisDataProxy.
  34  *
  35  * This header is only meant for internal use to implement
  36  * gmx::AbstractAnalysisData::setColumnModule().
  37  *
  38  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  39  * \ingroup module_analysisdata
  40  */
  41 #ifndef GMX_ANALYSISDATA_DATAPROXY_H
  42 #define GMX_ANALYSISDATA_DATAPROXY_H
  43
  44 #include "abstractdata.h"
  45 #include "datamodule.h"
  46
  47 namespace gmx
  48 {
  49
  50 /*! \internal \brief
  51  * Internal implementation class used to implement column modules.
  52  *
  53  * This class serves as a proxy between AbstractAnalysisData and the attached
  54  * AnalysisDataModuleInterface object.  For each notification that
  55  * AbstractAnalysisData sends, it maps it such that only the relevant columns
  56  * are visible to the AnalysisDataModuleInterface.  Similarly, it implements
  57  * the frame access methods of AbstractAnalysisData such that only the relevant
  58  * columns are returned.
  59  *
  60  * \ingroup module_analysisdata
  61  */
  62 class AnalysisDataProxy : public AbstractAnalysisData,
  63                           public AnalysisDataModuleInterface
  64 {
  65     public:
  66         /*! \brief
  67          * Creates a proxy object that only presents certain columns.
  68          *
  69          * \param[in] firstColumn  First column to present.
  70          * \param[in] columnSpan   Number of columns to present.
  71          * \param[in] data         Data object that should be wrapped.
  72          *
  73          * Does not throw.
  74          */
  75         AnalysisDataProxy(int firstColumn, int columnSpan,
  76                           AbstractAnalysisData *data);
  77
  78         virtual int flags() const;
  79
  80         virtual void dataStarted(AbstractAnalysisData *data);
  81         virtual void frameStarted(const AnalysisDataFrameHeader &frame);
  82         virtual void pointsAdded(const AnalysisDataPointSetRef &points);
  83         virtual void frameFinished(const AnalysisDataFrameHeader &header);
  84         virtual void dataFinished();
  85
  86     private:
  87         virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
  88         virtual bool requestStorageInternal(int nframes);
  89
  90         AbstractAnalysisData   &source_;
  91         int                     firstColumn_;
  92         int                     columnSpan_;
  93
  94         // Copy and assign disallowed by base.
  95 };
  96
  97 } // namespace gmx
  98
  99 #endif