src/OpenFOAM/global/clock/clock.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM 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 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::clock
  27
  28 Description
  29     Read access to the system clock with formatting.
  30
  31 SourceFiles
  32     clock.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef clock_H
  37 #define clock_H
  38
  39 #include <ctime>
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 class string;
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class clock Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class clock
  53 {
  54     // Private data
  55
  56         //- Start time in seconds
  57         time_t startTime_;
  58
  59         //- Time when clockTimeIncrement() was last called
  60         mutable time_t lastTime_;
  61
  62         //- Latest time from either elapsedClockTime() or clockTimeIncrement()
  63         mutable time_t newTime_;
  64
  65         //- Names of the months
  66         static const char *monthNames[];
  67
  68
  69 public:
  70
  71     // Constructors
  72
  73         //- Null constructor which stores the start time
  74         clock();
  75
  76
  77     // Member Functions
  78
  79         //- Get the current clock time in seconds
  80         static time_t getTime();
  81
  82         //- Return the current wall-clock date as a raw struct
  83         static const struct tm rawDate();
  84
  85         //- Return the current wall-clock date/time as a string
  86         //  format according to ISO-8601 (yyyy-mm-ddThh:mm:ss)
  87         static string dateTime();
  88
  89         //- Return the current wall-clock date as a string
  90         static string date();
  91
  92         //- Return the current wall-clock time as a string
  93         static string clockTime();
  94
  95         //- Returns wall-clock time from clock instantiation
  96         time_t elapsedClockTime() const;
  97
  98         //- Returns wall-clock time from last call of clockTimeIncrement()
  99         time_t clockTimeIncrement() const;
 100 };
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 } // End namespace Foam
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #endif
 110
 111 // ************************************************************************* //