Datatypes:
AjPTime | Time object |
none | time internals |
Sections:
constructors | Constructors |
destructors | Destructors |
get time | General use |
get reference to internals | Miscellaneous |
set time | Modifiers |
comparison | General use |
debug | General use |
exit | Miscellaneous |
Functions:
ajTimeNew | Constructor for AjPTime object. |
ajTimeNewDayFmt | Constructor for user specification of an arbitrary AjPTime object. Except for 'timefmt', the arguments are based upon the UNIX 'tm' time structure defined in the time.h header file. The range validity of numbers given are not checked. |
ajTimeNewTime | Constructor for AjPTime object, making a copy of an existing time object |
ajTimeNewToday | AJAX function to return today's time as an AjPTime object |
ajTimeNewTodayFmt | AJAX function to return today's time as an AjPTime object with a specified output format |
AjPTime ajTimeNew ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTime | RETURN | An AjPTime object |
From EMBOSS 2.8.0
AjPTime ajTimeNewDayFmt ( const char* timefmt, ajint mday, ajint mon, ajint year );
Type | Name | Read/Write | Description |
---|---|---|---|
const char* | timefmt | Input | Time format to use |
ajint | mday | Input | Day of the month [1-31] |
ajint | mon | Input | Month [1-12] |
ajint | year | Input | Four digit year |
AjPTime | RETURN | An AjPTime object |
From EMBOSS 5.0.0
AjPTime ajTimeNewTime ( const AjPTime src );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTime | src | Input | Time object to be copied |
AjPTime | RETURN | An AjPTime object |
From EMBOSS 5.0.0
AjPTime ajTimeNewToday ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTime | RETURN | Pointer to time object containing today's date/time |
From EMBOSS 5.0.0
AjPTime ajTimeNewTodayFmt ( const char* timefmt );
Type | Name | Read/Write | Description |
---|---|---|---|
const char* | timefmt | Input | A controlled vocabulary of time formats |
AjPTime | RETURN | Pointer to time object containing today's date/time |
From EMBOSS 5.0.0
Functions:
ajTimeDel | Destructor for AjPTime object. |
void ajTimeDel ( AjPTime* Ptime );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTime* | Ptime | Output | Time object pointer |
void | RETURN |
From EMBOSS 2.8.0
Functions:
ajTimeGetTimetype | An AjPTime object version of the mktime function that returns a standard time_t value |
time_t ajTimeGetTimetype ( const AjPTime thys );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTime | thys | Input | Time object |
time_t | RETURN | Standard time value |
From EMBOSS 5.0.0
Functions:
ajTimeRefToday | AJAX function to return today's time as an AjPTime object reference |
ajTimeRefTodayFmt | AJAX function to return today's time as a static AjPTime object with a specified output format |
const AjPTime ajTimeRefToday ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTime | RETURN | Pointer to static time object containing today's date/time |
From EMBOSS 5.0.0
const AjPTime ajTimeRefTodayFmt ( const char* timefmt );
Type | Name | Read/Write | Description |
---|---|---|---|
const char* | timefmt | Input | A controlled vocabulary of time formats |
const AjPTime | RETURN | Pointer to static time object containing today's date/time |
From EMBOSS 5.0.0
Functions:
ajTimeSetC | Constructor for user specification of an AjPTime object. using the time set as a string in format yyyy-mm-dd hh:mm:ss |
ajTimeSetS | Constructor for user specification of an AjPTime object. using the time set as a string in format yyyy-mm-dd hh:mm:ss |
ajTimeSetLocal | A localtime()/localtime_r() replacement for AjPTime objects |
AjBool ajTimeSetC ( AjPTime thys, const char* timestr );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTime | thys | Output | Time object |
const char* | timestr | Input | Time in format yyyy-mm-dd hh:mm:ss |
AjBool | RETURN | ajTrue on success |
From EMBOSS 5.0.0
AjBool ajTimeSetS ( AjPTime thys, const AjPStr timestr );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTime | thys | Output | Time object |
const AjPStr | timestr | Input | Time in format yyyy-mm-dd hh:mm:ss |
AjBool | RETURN | ajTrue on success |
From EMBOSS 3.0.0
AjBool ajTimeSetLocal ( AjPTime thys, const time_t timer );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTime | thys | Output | Time object |
const time_t | timer | Input | Populated standard C time structure |
AjBool | RETURN | true if successful |
From EMBOSS 5.0.0
Functions:
ajTimeDiff | Difference between two time objects |
double ajTimeDiff ( const AjPTime thys, const AjPTime newtime );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTime | thys | Input | Original time object |
const AjPTime | newtime | Input | Later time object |
double | RETURN | Difference in seconds |
From EMBOSS 6.0.0
Functions:
ajTimeTrace | Debug report on the contents of an AjPTime object |
void ajTimeTrace ( const AjPTime thys );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTime | thys | Input | Time object |
void | RETURN |
From EMBOSS 1.0.0
Functions:
ajTimeExit | Cleans up time processing internal memory |
void ajTimeExit ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
void | RETURN |
From EMBOSS 4.0.0
Sections:
reset | Miscellaneous |
Functions:
ajTimeReset | Resets the clock time to zero |
void ajTimeReset ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
void | RETURN |
From EMBOSS 6.1.0
Functions:
ajClockDiff | Returns the cpu time in seconds between two clock values |
ajClockNow | Returns the clock time as a long even for systems where the clock_t type is 4 bytes |
ajClockSeconds | Returns the cpu time in seconds since the start |
double ajClockDiff ( ajlong starttime, ajlong nowtime );
Type | Name | Read/Write | Description |
---|---|---|---|
ajlong | starttime | Input | start time |
ajlong | nowtime | Input | current time |
double | RETURN | Total cpu clock time in seconds |
From EMBOSS 6.1.0
ajlong ajClockNow ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
ajlong | RETURN | Total clock ticks |
From EMBOSS 6.1.0
double ajClockSeconds ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
double | RETURN | Total cpu clock time in seconds |
From EMBOSS 6.1.0
Functions:
ajClockReset | Resets the clock time to zero |
void ajClockReset ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
void | RETURN |
From EMBOSS 6.1.0