src/gromacs/analysisdata/dataproxy.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013, 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  * Implements gmx::AnalysisDataProxy.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_analysisdata
  41  */
  42 #include "dataproxy.h"
  43
  44 #include "gromacs/analysisdata/dataframe.h"
  45 #include "gromacs/analysisdata/datamodulemanager.h"
  46 #include "gromacs/utility/gmxassert.h"
  47
  48 namespace gmx
  49 {
  50
  51 AnalysisDataProxy::AnalysisDataProxy(int firstColumn, int columnSpan,
  52                                      AbstractAnalysisData *data)
  53     : source_(*data), firstColumn_(firstColumn), columnSpan_(columnSpan),
  54       bParallel_(false)
  55 {
  56     GMX_RELEASE_ASSERT(data != NULL, "Source data must not be NULL");
  57     GMX_RELEASE_ASSERT(firstColumn >= 0 && columnSpan > 0, "Invalid proxy column");
  58     setMultipoint(source_.isMultipoint());
  59 }
  60
  61
  62 int
  63 AnalysisDataProxy::frameCount() const
  64 {
  65     return source_.frameCount();
  66 }
  67
  68
  69 AnalysisDataFrameRef
  70 AnalysisDataProxy::tryGetDataFrameInternal(int index) const
  71 {
  72     AnalysisDataFrameRef frame = source_.tryGetDataFrame(index);
  73     if (!frame.isValid())
  74     {
  75         return AnalysisDataFrameRef();
  76     }
  77     return AnalysisDataFrameRef(frame, firstColumn_, columnSpan_);
  78 }
  79
  80
  81 bool
  82 AnalysisDataProxy::requestStorageInternal(int nframes)
  83 {
  84     return source_.requestStorage(nframes);
  85 }
  86
  87
  88 int
  89 AnalysisDataProxy::flags() const
  90 {
  91     return efAllowMultipoint | efAllowMulticolumn | efAllowMissing
  92            | efAllowMultipleDataSets;
  93 }
  94
  95
  96 void
  97 AnalysisDataProxy::dataStarted(AbstractAnalysisData *data)
  98 {
  99     GMX_RELEASE_ASSERT(data == &source_, "Source data mismatch");
 100     setDataSetCount(data->dataSetCount());
 101     for (int i = 0; i < data->dataSetCount(); ++i)
 102     {
 103         setColumnCount(i, columnSpan_);
 104     }
 105     moduleManager().notifyDataStart(this);
 106 }
 107
 108
 109 bool
 110 AnalysisDataProxy::parallelDataStarted(
 111         AbstractAnalysisData              *data,
 112         const AnalysisDataParallelOptions &options)
 113 {
 114     GMX_RELEASE_ASSERT(data == &source_, "Source data mismatch");
 115     setDataSetCount(data->dataSetCount());
 116     for (int i = 0; i < data->dataSetCount(); ++i)
 117     {
 118         setColumnCount(i, columnSpan_);
 119     }
 120     moduleManager().notifyParallelDataStart(this, options);
 121     bParallel_ = !moduleManager().hasSerialModules();
 122     return bParallel_;
 123 }
 124
 125
 126 void
 127 AnalysisDataProxy::frameStarted(const AnalysisDataFrameHeader &frame)
 128 {
 129     if (bParallel_)
 130     {
 131         moduleManager().notifyParallelFrameStart(frame);
 132     }
 133     else
 134     {
 135         moduleManager().notifyFrameStart(frame);
 136     }
 137 }
 138
 139
 140 void
 141 AnalysisDataProxy::pointsAdded(const AnalysisDataPointSetRef &points)
 142 {
 143     AnalysisDataPointSetRef columns(points, firstColumn_, columnSpan_);
 144     if (columns.columnCount() > 0)
 145     {
 146         if (bParallel_)
 147         {
 148             moduleManager().notifyParallelPointsAdd(columns);
 149         }
 150         else
 151         {
 152             moduleManager().notifyPointsAdd(columns);
 153         }
 154     }
 155 }
 156
 157
 158 void
 159 AnalysisDataProxy::frameFinished(const AnalysisDataFrameHeader &header)
 160 {
 161     if (bParallel_)
 162     {
 163         moduleManager().notifyParallelFrameFinish(header);
 164     }
 165     else
 166     {
 167         moduleManager().notifyFrameFinish(header);
 168     }
 169 }
 170
 171
 172 void
 173 AnalysisDataProxy::dataFinished()
 174 {
 175     moduleManager().notifyDataFinish();
 176 }
 177
 178 } // namespace gmx