#include <datetime.h>
Inheritance diagram for ucommon::Time:
Public Member Functions | |
long | get (void) |
Get current time in seconds from midnight. | |
int | hour (void) |
Get hours from midnight. | |
bool | is_valid (void) |
Check if time object had valid value. | |
int | minute (void) |
Get minutes from current hour. | |
long | operator * () |
Get object time in seconds. | |
operator bool () | |
Check if time object has valid value for is() operator. | |
operator long () | |
Get time in seconds. | |
bool | operator! () |
Check if time object has valid value for ! operator. | |
bool | operator!= (Time &time) |
Compare time with another time to see if not same time. | |
String | operator() () |
Convert to standard 24 hour time string. | |
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. | |
Time | operator- (long seconds) |
Subtract seconds to the current time, wrap if 24 hours. | |
long | operator- (Time &reference) |
Get difference (in seconds) between two times. | |
Time & | operator-- () |
Decrement time by 1 second, wrap on 24 hour period. | |
Time & | operator-= (long seconds) |
Decrement time by specified seconds. | |
bool | operator< (Time &time) |
Compare time if earlier than another time. | |
bool | operator<= (Time &time) |
Compare time if earlier than or equal to another time. | |
Time & | operator= (Time &time) |
Assign a time as a copy of another time. | |
bool | operator== (Time &time) |
Compare time with another time to see if same time. | |
bool | operator> (Time &time) |
Compare time if later than another time. | |
bool | operator>= (Time &time) |
Compare time if later than or equal to another time. | |
char * | put (char *buffer) |
Get a hh:mm:ss formatted string for current time. | |
int | second (void) |
Get seconds from current minute. | |
void | set (char *pointer, size_t size=0) |
Set time from a hh:mm:ss formatted string. | |
void | set (void) |
Set (update) the time with current time. | |
void | set (int hour, int minute=0, int second=0) |
Time () | |
Create a time from current time. | |
Time (Time &object) | |
Create a time object from another object. | |
Time (int hour, int minute, int second) | |
Create a time from hours (0-23), minutes (0-59), and seconds (0-59). | |
Time (char *pointer, size_t size=0) | |
Create a time from a hh:mm:ss formatted time string. | |
Time (tm_t *object) | |
Create a time from the time portion of a date and time object. | |
Time (time_t value) | |
Create a time from the time portion of a time_t. | |
virtual | ~Time () |
Destroy time object. | |
Static Public Attributes | |
static long | c_day |
Constant for number of seconds in a day. | |
static long | c_hour |
Constant for number of seconds in a hour. | |
static long | c_week |
Constant for number of seconds in a week. | |
static size_t | sz_string |
Size of time string field. | |
Protected Member Functions | |
virtual void | update (void) |
Protected Attributes | |
long | seconds |
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 345 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 | ( | Time & | object | ) |
Create a time object from another object.
object | to copy. |
long ucommon::Time::get | ( | void | ) |
Get current time in seconds from midnight.
Reimplemented in ucommon::DateTime.
int ucommon::Time::hour | ( | void | ) |
Get hours from midnight.
bool ucommon::Time::is_valid | ( | void | ) |
Check if time object had valid value.
Reimplemented in ucommon::DateTime.
int ucommon::Time::minute | ( | void | ) |
Get minutes from current hour.
long ucommon::Time::operator * | ( | ) | [inline] |
ucommon::Time::operator bool | ( | ) | [inline] |
Check if time object has valid value for is() operator.
Reimplemented in ucommon::DateTime.
Definition at line 472 of file datetime.h.
ucommon::Time::operator long | ( | ) | [inline] |
Get time in seconds.
Reimplemented in ucommon::DateTime.
Definition at line 507 of file datetime.h.
bool ucommon::Time::operator! | ( | ) | [inline] |
Check if time object has valid value for ! operator.
Reimplemented in ucommon::DateTime.
Definition at line 479 of file datetime.h.
bool ucommon::Time::operator!= | ( | Time & | time | ) |
Compare time with another time to see if not same time.
time | to compare with. |
String ucommon::Time::operator() | ( | ) |
Convert to standard 24 hour time string.
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.
Time ucommon::Time::operator- | ( | long | seconds | ) |
Subtract seconds to the current time, wrap if 24 hours.
seconds | to subtract. |
Reimplemented in ucommon::DateTime.
long ucommon::Time::operator- | ( | Time & | reference | ) |
Get difference (in seconds) between two times.
reference | time to get difference from. |
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< | ( | Time & | time | ) |
Compare time if earlier than another time.
time | object to compare with. |
bool ucommon::Time::operator<= | ( | 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== | ( | Time & | time | ) |
Compare time with another time to see if same time.
time | to compare with. |
bool ucommon::Time::operator> | ( | Time & | time | ) |
Compare time if later than another time.
time | object to compare with. |
bool ucommon::Time::operator>= | ( | Time & | time | ) |
Compare time if later than or equal to another time.
time | object to compare with. |
char* ucommon::Time::put | ( | char * | buffer | ) |
Get a hh:mm:ss formatted string for current time.
buffer | to store time string in. |
Reimplemented in ucommon::DateTime.
int ucommon::Time::second | ( | void | ) |
Get seconds from current minute.
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. |