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 of the gmx::AbstractAnalysisData
  36  * class to implement modules that handle only a subset of columns.
  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  * \ingroup module_analysisdata
  54  */
  55 class AnalysisDataProxy : public AbstractAnalysisData,
  56                           public AnalysisDataModuleInterface
  57 {
  58     public:
  59         /*! \brief
  60          * Creates a proxy object that only presents certain columns.
  61          *
  62          * \param[in] col   First column to present.
  63          * \param[in] span  Number of columns to present.
  64          * \param[in] data  Data object that should be wrapped.
  65          */
  66         AnalysisDataProxy(int col, int span, AbstractAnalysisData *data);
  67
  68         virtual int frameCount() const;
  69         virtual bool getDataWErr(int index, real *x, real *dx,
  70                                  const real **y, const real **dy,
  71                                  const bool **missing = 0) const;
  72         virtual bool requestStorage(int nframes = -1);
  73
  74         virtual int flags() const;
  75
  76         virtual void dataStarted(AbstractAnalysisData *data);
  77         virtual void frameStarted(real x, real dx);
  78         virtual void pointsAdded(real x, real dx, int firstcol, int n,
  79                                  const real *y, const real *dy,
  80                                  const bool *missing);
  81         virtual void frameFinished();
  82         virtual void dataFinished();
  83
  84     private:
  85         AbstractAnalysisData   &_source;
  86         int                     _col;
  87         int                     _span;
  88
  89         // Copy and assign disallowed by base.
  90 };
  91
  92 } // namespace gmx
  93
  94 #endif