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 by the GROMACS development team.
   5  * Copyright (c) 2015,2018,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Declares gmx::AnalysisDataProxy.
  39  *
  40  * This header is only meant for internal use to implement
  41  * gmx::AbstractAnalysisData::setColumnModule().
  42  *
  43  * \author Teemu Murtola <teemu.murtola@gmail.com>
  44  * \ingroup module_analysisdata
  45  */
  46 #ifndef GMX_ANALYSISDATA_DATAPROXY_H
  47 #define GMX_ANALYSISDATA_DATAPROXY_H
  48
  49 #include "gromacs/analysisdata/abstractdata.h"
  50 #include "gromacs/analysisdata/datamodule.h"
  51
  52 namespace gmx
  53 {
  54
  55 /*! \internal
  56  * \brief
  57  * Internal implementation class used to implement column modules.
  58  *
  59  * This class serves as a proxy between AbstractAnalysisData and the attached
  60  * IAnalysisDataModule object.  For each notification that
  61  * AbstractAnalysisData sends, it maps it such that only the relevant columns
  62  * are visible to the IAnalysisDataModule.  Similarly, it implements
  63  * the frame access methods of AbstractAnalysisData such that only the relevant
  64  * columns are returned.
  65  *
  66  * \ingroup module_analysisdata
  67  */
  68 class AnalysisDataProxy : public AbstractAnalysisData, public IAnalysisDataModule
  69 {
  70 public:
  71     /*! \brief
  72      * Creates a proxy object that only presents certain columns.
  73      *
  74      * \param[in] firstColumn  First column to present.
  75      * \param[in] columnSpan   Number of columns to present.
  76      * \param[in] data         Data object that should be wrapped.
  77      *
  78      * Does not throw.
  79      */
  80     AnalysisDataProxy(int firstColumn, int columnSpan, AbstractAnalysisData* data);
  81
  82     int frameCount() const override;
  83
  84     int flags() const override;
  85
  86     void dataStarted(AbstractAnalysisData* data) override;
  87     bool parallelDataStarted(AbstractAnalysisData* data, const AnalysisDataParallelOptions& options) override;
  88     void frameStarted(const AnalysisDataFrameHeader& frame) override;
  89     void pointsAdded(const AnalysisDataPointSetRef& points) override;
  90     void frameFinished(const AnalysisDataFrameHeader& header) override;
  91     void frameFinishedSerial(int frameIndex) override;
  92     void dataFinished() override;
  93
  94 private:
  95     AnalysisDataFrameRef tryGetDataFrameInternal(int index) const override;
  96     bool                 requestStorageInternal(int nframes) override;
  97
  98     AbstractAnalysisData& source_;
  99     int                   firstColumn_;
 100     int                   columnSpan_;
 101     bool                  bParallel_;
 102
 103     // Copy and assign disallowed by base.
 104 };
 105
 106 } // namespace gmx
 107
 108 #endif