Main Page   Alphabetical List   Compound List   File List   Compound Members   File Members  

tstamp.h File Reference

Formatted time routines. More...

Go to the source code of this file.

Enumerations

enum  TsSelector_ { TS_UTIME = 1, TS_STIME = 2, TS_CUTIME = 4, TS_CSTIME = 8 }
 TsSelector_: user and sys times of the current process and its children may be queried after each start_timer() / stop_timer() call pair. More...


Functions

char* time_stamp (void)
 time_stamp(): returns a pointer to an internal static string that contains a time string in the following format:- "Thu 02-Jun-1994 18:24:23". More...

char* greeting (void)
 greeting(): returns a pointer to an internal static string that contains a greeting appropriate for the time of the day: "Good morning" from 6am till noon, "Good afternoon" from 12:01pm until 6pm, "Good evening" from 6:01pm until 10pm and "Good night" for want of anything more appropriate otherwise. More...

long julian_date (unsigned int Day, unsigned int Month, int Year)
 julian_date(Day, Month, Year): calculates the Julian date at date Day/Month/Year where 1<=Day<=31, 1<=Month<=12. More...

void start_timer (void)
 start_timer(): starts a timer by saving the current time in an internal variable.

void stop_timer (void)
 stop_timer(): stops the timer by saving the current time in another internal variable. More...

long timer_results (int Sel)
 timer_results(Sel): returns the time (in integer seconds) elapsed between the last calls to start_timer() and stop_timer(). More...

const char* time_string (long T)
 time_string(T): when given a time (interval) in seconds in T, this routine returns a ptr to an internal character buffer holding a formatted string like "26 days 1 hour 3 mins 55 secs". More...


Detailed Description

Formatted time routines.

Provides time stamps, a simple execution timer, Julian date calculation and a greeting string generator that is aware of the time of the day.

Definition in file tstamp.h.


Enumeration Type Documentation

enum TsSelector_
 

TsSelector_: user and sys times of the current process and its children may be queried after each start_timer() / stop_timer() call pair.

These enums decide which is returned by timer_results(). By OR-ing them together, sums of these times may be obtained.

Enumeration values:
TS_UTIME  
TS_STIME  
TS_CUTIME  
TS_CSTIME  

Definition at line 28 of file tstamp.h.


Function Documentation

char * time_stamp ( void )
 

time_stamp(): returns a pointer to an internal static string that contains a time string in the following format:- "Thu 02-Jun-1994 18:24:23".

The string is evaluated at the time of the call and is overwritten between calls.

char * greeting ( void )
 

greeting(): returns a pointer to an internal static string that contains a greeting appropriate for the time of the day: "Good morning" from 6am till noon, "Good afternoon" from 12:01pm until 6pm, "Good evening" from 6:01pm until 10pm and "Good night" for want of anything more appropriate otherwise.

The string is evaluated at the time of the call and is overwritten between calls.

long julian_date ( unsigned int Day,
unsigned int Month,
int Year )
 

julian_date(Day, Month, Year): calculates the Julian date at date Day/Month/Year where 1<=Day<=31, 1<=Month<=12.

Values outside these intervals will be bracketed silently. Year!=0, will be set to 1. Year<0 indicates dates BC.

void start_timer ( void )
 

start_timer(): starts a timer by saving the current time in an internal variable.

void stop_timer ( void )
 

stop_timer(): stops the timer by saving the current time in another internal variable.

The start time is not affected.

long timer_results ( int Sel )
 

timer_results(Sel): returns the time (in integer seconds) elapsed between the last calls to start_timer() and stop_timer().

User and system times for the current process and its children are tracked separately. E.g. timer_results(TS_UTIME) returns the user time of the process, timer_results(TS_CUTIME|TS_CSTIME) returns the total time of the children. The four times can be summed in any combination by OR-ing the corresponding constants (see TsSelector_) together.

const char * time_string ( long T )
 

time_string(T): when given a time (interval) in seconds in T, this routine returns a ptr to an internal character buffer holding a formatted string like "26 days 1 hour 3 mins 55 secs".

This string is overwritten by each call. Fractions of seconds are not supported and T<0 is interpreted as T==0.


Generated at Wed Aug 21 09:33:39 2002 for The Razorback C Library: Miscellaneous Utilities by doxygen1.2.6 written by Dimitri van Heesch, © 1997-2001