UCommon
|
The Time class uses a integer representation of the current time. More...
#include <datetime.h>
Public Types | |
enum | index_t { hour = 20, minute, second } |
Component access index. |
Public Member Functions | |
long | get (void) const |
Get current time in seconds from midnight. | |
char * | get (char *buffer) const |
Get a hh:mm:ss formatted string for current time. | |
int | getHour (void) const |
Get hours from midnight. | |
int | getMinute (void) const |
Get minutes from current hour. | |
int | getSecond (void) const |
Get seconds from current minute. | |
bool | isValid (void) const |
Check if time object had valid value. | |
operator bool () const | |
Check if time object has valid value for is() operator. | |
operator long () | |
Get time in seconds. | |
bool | operator! () const |
Check if time object has valid value for ! operator. | |
bool | operator!= (const Time &time) |
Compare time with another time to see if not same time. | |
String | operator() () const |
Convert to standard 24 hour time string. | |
long | operator* () const |
Get object time in seconds. | |
Time | operator+ (long seconds) |
Add seconds to the current time, wrap if 24 hours. | |
Time & | operator++ () |
Incrememnt time by 1 second, wrap on 24 hour period. | |
Time & | operator+= (long seconds) |
Increment time by specified seconds. | |
long | operator- (const Time &reference) |
Get difference (in seconds) between two times. | |
Time | operator- (long seconds) |
Subtract seconds to the current time, wrap if 24 hours. | |
Time & | operator-- () |
Decrement time by 1 second, wrap on 24 hour period. | |
Time & | operator-= (long seconds) |
Decrement time by specified seconds. | |
bool | operator< (const Time &time) |
Compare time if earlier than another time. | |
bool | operator<= (const Time &time) |
Compare time if earlier than or equal to another time. | |
Time & | operator= (const Time &time) |
Assign a time as a copy of another time. | |
bool | operator== (const Time &time) |
Compare time with another time to see if same time. | |
bool | operator> (const Time &time) |
Compare time if later than another time. | |
bool | operator>= (const Time &time) |
Compare time if later than or equal to another time. | |
int | operator[] (index_t component) const |
Get component of time object. | |
void | set (void) |
Set (update) the time with current time. | |
void | set (char *pointer, size_t size=0) |
Set time from a hh:mm:ss formatted string. | |
Time (time_t value) | |
Create a time from the time portion of a time_t. | |
Time (tm_t *object) | |
Create a time from the time portion of a date and time object. | |
Time (char *pointer, size_t size=0) | |
Create a time from a hh:mm:ss formatted time string. | |
Time (int hour, int minute, int second) | |
Create a time from hours (0-23), minutes (0-59), and seconds (0-59). | |
Time (const Time &object) | |
Create a time object from another object. | |
Time () | |
Create a time from current time. | |
virtual | ~Time () |
Destroy time object. |
Static Public Attributes | |
static const size_t | sz_string |
Size of time string field. |
Protected Member Functions | |
void | fromSeconds (char *buf) const |
void | toSeconds (int hour, int minute=0, int second=0) |
virtual void | update (void) |
Protected Attributes | |
long | seconds |
The Time class uses a integer representation of the current time.
This is then manipulated in several forms and may be exported as needed. The time object can represent an instance in time (hours, minutes, and seconds) in a 24 hour period or can represent a duration. Millisecond accuracy can be offered.
Definition at line 360 of file datetime.h.
ucommon::Time::Time | ( | time_t | value | ) |
Create a time from the time portion of a time_t.
value | of time_t to use. |
ucommon::Time::Time | ( | tm_t * | object | ) |
Create a time from the time portion of a date and time object.
object | from DateTime::glt() or gmt(). |
ucommon::Time::Time | ( | char * | pointer, |
size_t | size = 0 |
||
) |
Create a time from a hh:mm:ss formatted time string.
pointer | to formatted time field. |
size | of field if not null terminated. |
ucommon::Time::Time | ( | int | hour, |
int | minute, | ||
int | second | ||
) |
Create a time from hours (0-23), minutes (0-59), and seconds (0-59).
hour | of time. |
minute | of time. |
second | of time. |
ucommon::Time::Time | ( | const Time & | object | ) |
Create a time object from another object.
object | to copy. |
long ucommon::Time::get | ( | void | ) | const |
Get current time in seconds from midnight.
Reimplemented in ucommon::DateTime.
char* ucommon::Time::get | ( | char * | buffer | ) | const |
Get a hh:mm:ss formatted string for current time.
buffer | to store time string in. |
Reimplemented in ucommon::DateTime.
int ucommon::Time::getHour | ( | void | ) | const |
Get hours from midnight.
int ucommon::Time::getMinute | ( | void | ) | const |
Get minutes from current hour.
int ucommon::Time::getSecond | ( | void | ) | const |
Get seconds from current minute.
bool ucommon::Time::isValid | ( | void | ) | const |
Check if time object had valid value.
Reimplemented in ucommon::DateTime.
|
inline |
Check if time object has valid value for is() operator.
Reimplemented in ucommon::DateTime.
Definition at line 477 of file datetime.h.
|
inline |
|
inline |
Check if time object has valid value for ! operator.
Reimplemented in ucommon::DateTime.
Definition at line 484 of file datetime.h.
bool ucommon::Time::operator!= | ( | const Time & | time | ) |
Compare time with another time to see if not same time.
time | to compare with. |
String ucommon::Time::operator() | ( | ) | const |
Convert to standard 24 hour time string.
|
inline |
Time ucommon::Time::operator+ | ( | long | seconds | ) |
Add seconds to the current time, wrap if 24 hours.
seconds | to add. |
Reimplemented in ucommon::DateTime.
Time& ucommon::Time::operator++ | ( | ) |
Incrememnt time by 1 second, wrap on 24 hour period.
Reimplemented in ucommon::DateTime.
Time& ucommon::Time::operator+= | ( | long | seconds | ) |
Increment time by specified seconds.
Wraps on 24 hour period.
seconds | to add to current time. |
Reimplemented in ucommon::DateTime.
long ucommon::Time::operator- | ( | const Time & | reference | ) |
Get difference (in seconds) between two times.
reference | time to get difference from. |
Time ucommon::Time::operator- | ( | long | seconds | ) |
Subtract seconds to the current time, wrap if 24 hours.
seconds | to subtract. |
Reimplemented in ucommon::DateTime.
Time& ucommon::Time::operator-- | ( | ) |
Decrement time by 1 second, wrap on 24 hour period.
Reimplemented in ucommon::DateTime.
Time& ucommon::Time::operator-= | ( | long | seconds | ) |
Decrement time by specified seconds.
Wraps on 24 hour period.
seconds | to subtract from current time. |
Reimplemented in ucommon::DateTime.
bool ucommon::Time::operator< | ( | const Time & | time | ) |
Compare time if earlier than another time.
time | object to compare with. |
bool ucommon::Time::operator<= | ( | const Time & | time | ) |
Compare time if earlier than or equal to another time.
time | object to compare with. |
Assign a time as a copy of another time.
time | to assign from. |
bool ucommon::Time::operator== | ( | const Time & | time | ) |
Compare time with another time to see if same time.
time | to compare with. |
bool ucommon::Time::operator> | ( | const Time & | time | ) |
Compare time if later than another time.
time | object to compare with. |
bool ucommon::Time::operator>= | ( | const Time & | time | ) |
Compare time if later than or equal to another time.
time | object to compare with. |
int ucommon::Time::operator[] | ( | index_t | component | ) | const |
Get component of time object.
component | index. |
void ucommon::Time::set | ( | char * | pointer, |
size_t | size = 0 |
||
) |
Set time from a hh:mm:ss formatted string.
pointer | to time field. |
size | of field if not null terminated. |