src/gromacs/analysisdata/dataproxy.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014,2015,2018,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 /*! \internal \file
  36  * \brief
  37  * Declares gmx::AnalysisDataProxy.
  38  *
  39  * This header is only meant for internal use to implement
  40  * gmx::AbstractAnalysisData::setColumnModule().
  41  *
  42  * \author Teemu Murtola <teemu.murtola@gmail.com>
  43  * \ingroup module_analysisdata
  44  */
  45 #ifndef GMX_ANALYSISDATA_DATAPROXY_H
  46 #define GMX_ANALYSISDATA_DATAPROXY_H
  47
  48 #include "gromacs/analysisdata/abstractdata.h"
  49 #include "gromacs/analysisdata/datamodule.h"
  50
  51 namespace gmx
  52 {
  53
  54 /*! \internal
  55  * \brief
  56  * Internal implementation class used to implement column modules.
  57  *
  58  * This class serves as a proxy between AbstractAnalysisData and the attached
  59  * IAnalysisDataModule object.  For each notification that
  60  * AbstractAnalysisData sends, it maps it such that only the relevant columns
  61  * are visible to the IAnalysisDataModule.  Similarly, it implements
  62  * the frame access methods of AbstractAnalysisData such that only the relevant
  63  * columns are returned.
  64  *
  65  * \ingroup module_analysisdata
  66  */
  67 class AnalysisDataProxy : public AbstractAnalysisData, public IAnalysisDataModule
  68 {
  69 public:
  70     /*! \brief
  71      * Creates a proxy object that only presents certain columns.
  72      *
  73      * \param[in] firstColumn  First column to present.
  74      * \param[in] columnSpan   Number of columns to present.
  75      * \param[in] data         Data object that should be wrapped.
  76      *
  77      * Does not throw.
  78      */
  79     AnalysisDataProxy(int firstColumn, int columnSpan, AbstractAnalysisData* data);
  80
  81     int frameCount() const override;
  82
  83     int flags() const override;
  84
  85     void dataStarted(AbstractAnalysisData* data) override;
  86     bool parallelDataStarted(AbstractAnalysisData* data, const AnalysisDataParallelOptions& options) override;
  87     void frameStarted(const AnalysisDataFrameHeader& frame) override;
  88     void pointsAdded(const AnalysisDataPointSetRef& points) override;
  89     void frameFinished(const AnalysisDataFrameHeader& header) override;
  90     void frameFinishedSerial(int frameIndex) override;
  91     void dataFinished() override;
  92
  93 private:
  94     AnalysisDataFrameRef tryGetDataFrameInternal(int index) const override;
  95     bool                 requestStorageInternal(int nframes) override;
  96
  97     AbstractAnalysisData& source_;
  98     int                   firstColumn_;
  99     int                   columnSpan_;
 100     bool                  bParallel_;
 101
 102     // Copy and assign disallowed by base.
 103 };
 104
 105 } // namespace gmx
 106
 107 #endif