FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

clock.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::clock
00026 
00027 Description
00028     Read access to the system clock with formatting.
00029 
00030 SourceFiles
00031     clock.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef clock_H
00036 #define clock_H
00037 
00038 #include <ctime>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 class string;
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class clock Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class clock
00052 {
00053     // Private data
00054 
00055         //- Start time in seconds
00056         time_t startTime_;
00057 
00058         //- Time when clockTimeIncrement() was last called
00059         mutable time_t lastTime_;
00060 
00061         //- Latest time from either elapsedClockTime() or clockTimeIncrement()
00062         mutable time_t newTime_;
00063 
00064         //- Names of the months
00065         static const char *monthNames[];
00066 
00067 
00068 public:
00069 
00070     // Constructors
00071 
00072         //- Null constructor which stores the start time
00073         clock();
00074 
00075 
00076     // Member Functions
00077 
00078         //- Get the current clock time in seconds
00079         static time_t getTime();
00080 
00081         //- Return the current wall-clock date as a raw struct
00082         static const struct tm rawDate();
00083 
00084         //- Return the current wall-clock date/time as a string
00085         //  format according to ISO-8601 (yyyy-mm-ddThh:mm:ss)
00086         static string dateTime();
00087 
00088         //- Return the current wall-clock date as a string
00089         static string date();
00090 
00091         //- Return the current wall-clock time as a string
00092         static string clockTime();
00093 
00094         //- Returns wall-clock time from clock instantiation
00095         time_t elapsedClockTime() const;
00096 
00097         //- Returns wall-clock time from last call of clockTimeIncrement()
00098         time_t clockTimeIncrement() const;
00099 };
00100 
00101 
00102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00103 
00104 } // End namespace Foam
00105 
00106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00107 
00108 #endif
00109 
00110 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines