clock Class Reference

Read access to the system clock with formatting. More...

Inheritance diagram for clock:

Public Member Functions
	clock ()
	Construct with the current clock time for the start point. More...
double	elapsedClockTime () const
	Returns wall-clock time since clock instantiation. More...
double	clockTimeIncrement () const
	Returns wall-clock time since last clockTimeIncrement() call. More...

Static Public Member Functions
static time_t	getTime ()
	Get the current clock time in seconds. More...
static const struct tm	rawDate ()
	The current wall-clock date as a raw struct. More...
static std::string	dateTime ()
	The current wall-clock date/time (in local time) as a string in ISO-8601 format (yyyy-mm-ddThh:mm:ss). More...
static std::string	date ()
	The current wall-clock date as a string formatted as (MON dd yyyy), where MON is Jan, Feb, etc. More...
static std::string	clockTime ()
	The current wall-clock (in local time) as a string formatted as as (hh:mm:ss). More...

Detailed Description

Read access to the system clock with formatting.

Source files

• clock.H
• clock.C

Definition at line 48 of file clock.H.

Constructor & Destructor Documentation

clock()

clock

(

)

Construct with the current clock time for the start point.

Definition at line 106 of file clock.C.

Member Function Documentation

getTime()

time_t getTime ( )

static

Get the current clock time in seconds.

Definition at line 39 of file clock.C.

rawDate()

const struct tm rawDate ( )

static

The current wall-clock date as a raw struct.

Deprecated:

(2020-05) may be removed in future versions

Definition at line 45 of file clock.C.

dateTime()

std::string dateTime ( )

static

The current wall-clock date/time (in local time) as a string in ISO-8601 format (yyyy-mm-ddThh:mm:ss).

Without time-zone information.

Definition at line 53 of file clock.C.

References Foam::setfill(), and Foam::setw().

Referenced by OBJedgeFormat::write(), STARCDsurfaceFormatCore::writeCase(), STARCDedgeFormat::writeCase(), and profilingSysInfo::writeEntries().

Here is the call graph for this function:

Here is the caller graph for this function:

date()

std::string date ( )

static

The current wall-clock date as a string formatted as (MON dd yyyy), where MON is Jan, Feb, etc.

Definition at line 73 of file clock.C.

References monthNames, Foam::setfill(), and Foam::setw().

Referenced by argList::parse(), foamReport::setDynamicBuiltins(), and foamReport::setStaticBuiltins().

Here is the call graph for this function:

Here is the caller graph for this function:

clockTime()

std::string clockTime ( )

static

The current wall-clock (in local time) as a string formatted as as (hh:mm:ss).

Without time-zone information.

Definition at line 88 of file clock.C.

References Foam::setfill(), and Foam::setw().

Referenced by argList::parse(), foamReport::setDynamicBuiltins(), and foamReport::setStaticBuiltins().

Here is the call graph for this function:

Here is the caller graph for this function:

elapsedClockTime()

double elapsedClockTime

(

)

const

Returns wall-clock time since clock instantiation.

Definition at line 115 of file clock.C.

clockTimeIncrement()

double clockTimeIncrement

(

)

const

Returns wall-clock time since last clockTimeIncrement() call.

Definition at line 122 of file clock.C.

---

The documentation for this class was generated from the following files:

• src/OpenFOAM/global/clock/clock.H
• src/OpenFOAM/global/clock/clock.C