/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
*
- * G R O M A C S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
*
- * GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
*
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
/*! \internal \file
* \brief
* Declares gmx::AnalysisDataProxy.
*
- * This header is only meant for internal use of the gmx::AbstractAnalysisData
- * class to implement modules that handle only a subset of columns.
+ * This header is only meant for internal use to implement
+ * gmx::AbstractAnalysisData::setColumnModule().
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
* \ingroup module_analysisdata
*/
#ifndef GMX_ANALYSISDATA_DATAPROXY_H
#define GMX_ANALYSISDATA_DATAPROXY_H
-#include "abstractdata.h"
-#include "datamodule.h"
+#include "gromacs/analysisdata/abstractdata.h"
+#include "gromacs/analysisdata/datamodule.h"
namespace gmx
{
-/*! \internal \brief
+/*! \internal
+ * \brief
* Internal implementation class used to implement column modules.
*
+ * This class serves as a proxy between AbstractAnalysisData and the attached
+ * AnalysisDataModuleInterface object. For each notification that
+ * AbstractAnalysisData sends, it maps it such that only the relevant columns
+ * are visible to the AnalysisDataModuleInterface. Similarly, it implements
+ * the frame access methods of AbstractAnalysisData such that only the relevant
+ * columns are returned.
+ *
* \ingroup module_analysisdata
*/
class AnalysisDataProxy : public AbstractAnalysisData,
/*! \brief
* Creates a proxy object that only presents certain columns.
*
- * \param[in] col First column to present.
- * \param[in] span Number of columns to present.
- * \param[in] data Data object that should be wrapped.
+ * \param[in] firstColumn First column to present.
+ * \param[in] columnSpan Number of columns to present.
+ * \param[in] data Data object that should be wrapped.
+ *
+ * Does not throw.
*/
- AnalysisDataProxy(int col, int span, AbstractAnalysisData *data);
+ AnalysisDataProxy(int firstColumn, int columnSpan,
+ AbstractAnalysisData *data);
virtual int frameCount() const;
- virtual int getDataWErr(int index, real *x, real *dx,
- const real **y, const real **dy,
- const bool **missing = 0) const;
- virtual int requestStorage(int nframes = -1);
virtual int flags() const;
- virtual int dataStarted(AbstractAnalysisData *data);
- virtual int frameStarted(real x, real dx);
- virtual int pointsAdded(real x, real dx, int firstcol, int n,
- const real *y, const real *dy,
- const bool *missing);
- virtual int frameFinished();
- virtual int dataFinished();
+ virtual void dataStarted(AbstractAnalysisData *data);
+ virtual bool parallelDataStarted(
+ AbstractAnalysisData *data,
+ const AnalysisDataParallelOptions &options);
+ virtual void frameStarted(const AnalysisDataFrameHeader &frame);
+ virtual void pointsAdded(const AnalysisDataPointSetRef &points);
+ virtual void frameFinished(const AnalysisDataFrameHeader &header);
+ virtual void dataFinished();
private:
- AbstractAnalysisData &_source;
- int _col;
- int _span;
+ virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
+ virtual bool requestStorageInternal(int nframes);
+
+ AbstractAnalysisData &source_;
+ int firstColumn_;
+ int columnSpan_;
+ bool bParallel_;
// Copy and assign disallowed by base.
};
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff