src/foam/global/profiling/profilingTrigger.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::profilingTrigger
  26
  27 Description
  28     The object that does the actual measuring
  29
  30 SourceFiles
  31     profilingTrigger.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef profilingTrigger_H
  36 #define profilingTrigger_H
  37
  38 #include "clockTime.H"
  39 #include "foamString.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46     class profilingInfo;
  47     class profilingPool;
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class profilingTrigger Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class profilingTrigger
  54 {
  55     // Private data
  56
  57     clockTime clock_;
  58
  59     profilingInfo &info_;
  60
  61     bool running_;
  62
  63     // Private Member Functions
  64
  65     //- Disallow default bitwise copy construct
  66     profilingTrigger(const profilingTrigger&);
  67
  68     //- Disallow default bitwise assignment
  69     void operator=(const profilingTrigger&);
  70
  71 protected:
  72
  73     clockTime &clock()
  74         { return clock_; }
  75
  76     const profilingInfo &info() const
  77         { return info_; }
  78
  79 public:
  80
  81     // Constructors
  82
  83     profilingTrigger(const string &name);
  84
  85     ~profilingTrigger();
  86
  87     void stop();
  88
  89     friend class profilingPool;
  90 };
  91
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace Foam
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 #endif
 100
 101 // ************************************************************************* //