2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
5 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
6 * others, as listed in the AUTHORS file in the top-level source
7 * directory and at http://www.gromacs.org.
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.
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.
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.
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.
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.
37 * Declares gmx::AnalysisDataProxy.
39 * This header is only meant for internal use to implement
40 * gmx::AbstractAnalysisData::setColumnModule().
42 * \author Teemu Murtola <teemu.murtola@gmail.com>
43 * \ingroup module_analysisdata
45 #ifndef GMX_ANALYSISDATA_DATAPROXY_H
46 #define GMX_ANALYSISDATA_DATAPROXY_H
48 #include "abstractdata.h"
49 #include "datamodule.h"
55 * Internal implementation class used to implement column modules.
57 * This class serves as a proxy between AbstractAnalysisData and the attached
58 * AnalysisDataModuleInterface object. For each notification that
59 * AbstractAnalysisData sends, it maps it such that only the relevant columns
60 * are visible to the AnalysisDataModuleInterface. Similarly, it implements
61 * the frame access methods of AbstractAnalysisData such that only the relevant
62 * columns are returned.
64 * \ingroup module_analysisdata
66 class AnalysisDataProxy : public AbstractAnalysisData,
67 public AnalysisDataModuleInterface
71 * Creates a proxy object that only presents certain columns.
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.
79 AnalysisDataProxy(int firstColumn, int columnSpan,
80 AbstractAnalysisData *data);
82 virtual int flags() const;
84 virtual void dataStarted(AbstractAnalysisData *data);
85 virtual void frameStarted(const AnalysisDataFrameHeader &frame);
86 virtual void pointsAdded(const AnalysisDataPointSetRef &points);
87 virtual void frameFinished(const AnalysisDataFrameHeader &header);
88 virtual void dataFinished();
91 virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
92 virtual bool requestStorageInternal(int nframes);
94 AbstractAnalysisData &source_;
98 // Copy and assign disallowed by base.