src/testutils/mock_datamodule.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \libinternal \file
  32  * \brief
  33  * Declares mock implementation of gmx::AnalysisDataModuleInterface.
  34  *
  35  * Requires Google Mock.
  36  *
  37  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  38  * \inlibraryapi
  39  * \ingroup module_testutils
  40  */
  41 #ifndef GMX_TESTUTILS_MOCK_DATAMODULE_H
  42 #define GMX_TESTUTILS_MOCK_DATAMODULE_H
  43
  44 #include <boost/shared_ptr.hpp>
  45 #include <gmock/gmock.h>
  46
  47 #include "gromacs/analysisdata/dataframe.h"
  48 #include "gromacs/analysisdata/datamodule.h"
  49 #include "gromacs/utility/common.h"
  50
  51 namespace gmx
  52 {
  53 namespace test
  54 {
  55
  56 class AnalysisDataTestInput;
  57 class TestReferenceChecker;
  58
  59 class MockAnalysisDataModule : public AnalysisDataModuleInterface
  60 {
  61     public:
  62         explicit MockAnalysisDataModule(int flags);
  63         virtual ~MockAnalysisDataModule();
  64
  65         virtual int flags() const;
  66
  67         MOCK_METHOD1(dataStarted, void(AbstractAnalysisData *data));
  68         MOCK_METHOD1(frameStarted, void(const AnalysisDataFrameHeader &header));
  69         MOCK_METHOD1(pointsAdded, void(const AnalysisDataPointSetRef &points));
  70         MOCK_METHOD1(frameFinished, void(const AnalysisDataFrameHeader &header));
  71         MOCK_METHOD0(dataFinished, void());
  72
  73         void setupStaticCheck(const AnalysisDataTestInput &data,
  74                               AbstractAnalysisData        *source);
  75         void setupStaticColumnCheck(const AnalysisDataTestInput &data,
  76                                     int firstcol, int n,
  77                                     AbstractAnalysisData *source);
  78         void setupStaticStorageCheck(const AnalysisDataTestInput &data,
  79                                      int                          storageCount,
  80                                      AbstractAnalysisData        *source);
  81         void setupReferenceCheck(const TestReferenceChecker &checker,
  82                                  AbstractAnalysisData       *source);
  83
  84     private:
  85         class Impl;
  86
  87         PrivateImplPointer<Impl> impl_;
  88 };
  89
  90 //! Smart pointer to manage an MockAnalysisDataModule object.
  91 typedef boost::shared_ptr<MockAnalysisDataModule>
  92     MockAnalysisDataModulePointer;
  93
  94 } // namespace test
  95 } // namespace gmx
  96
  97 #endif