ucommon
|
The Time class uses a integer representation of the current time. More...
#include <datetime.h>
Public Member Functions | |
long | get (void) const |
Get current time in seconds from midnight. | |
int | hour (void) const |
Get hours from midnight. | |
bool | is_valid (void) const |
Check if time object had valid value. | |
int | minute (void) const |
Get minutes from current hour. | |
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) const |
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) const |
Compare time if earlier than another time. | |
bool | operator<= (const Time &time) const |
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) const |
Compare time with another time to see if same time. | |
bool | operator> (const Time &time) const |
Compare time if later than another time. | |
bool | operator>= (const Time &time) const |
Compare time if later than or equal to another time. | |
const char * | put (char *buffer) const |
Get a hh:mm:ss formatted string for current time. | |
int | second (void) const |
Get seconds from current minute. | |
void | set (int hour, int minute=0, int second=0) |
void | set (void) |
Set (update) the time with current time. | |
void | set (const 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 (const 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 long | c_day |
Constant for number of seconds in a day. | |
static const long | c_hour |
Constant for number of seconds in a hour. | |
static const long | c_week |
Constant for number of seconds in a week. | |
static const size_t | sz_string |
Size of time string field. | |
Protected Member Functions | |
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 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 | ( | const 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.
int ucommon::Time::hour | ( | void | ) | const |
Get hours from midnight.
bool ucommon::Time::is_valid | ( | void | ) | const |
Check if time object had valid value.
int ucommon::Time::minute | ( | void | ) | const |
Get minutes from current hour.
|
inline |
Check if time object has valid value for is() operator.
Definition at line 472 of file datetime.h.
|
inline |
|
inline |
Check if time object has valid value for ! operator.
Definition at line 479 of file datetime.h.
bool ucommon::Time::operator!= | ( | const Time & | time | ) | const |
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. |
Time& ucommon::Time::operator++ | ( | ) |
Incrememnt time by 1 second, wrap on 24 hour period.
Time& ucommon::Time::operator+= | ( | long | seconds | ) |
Increment time by specified seconds.
Wraps on 24 hour period.
seconds | to add to current time. |
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. |
Time& ucommon::Time::operator-- | ( | ) |
Decrement time by 1 second, wrap on 24 hour period.
Time& ucommon::Time::operator-= | ( | long | seconds | ) |
Decrement time by specified seconds.
Wraps on 24 hour period.
seconds | to subtract from current time. |
bool ucommon::Time::operator< | ( | const Time & | time | ) | const |
Compare time if earlier than another time.
time | object to compare with. |
bool ucommon::Time::operator<= | ( | const Time & | time | ) | const |
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 | ) | const |
Compare time with another time to see if same time.
time | to compare with. |
bool ucommon::Time::operator> | ( | const Time & | time | ) | const |
Compare time if later than another time.
time | object to compare with. |
bool ucommon::Time::operator>= | ( | const Time & | time | ) | const |
Compare time if later than or equal to another time.
time | object to compare with. |
const char* ucommon::Time::put | ( | char * | buffer | ) | const |
Get a hh:mm:ss formatted string for current time.
buffer | to store time string in. |
int ucommon::Time::second | ( | void | ) | const |
Get seconds from current minute.
void ucommon::Time::set | ( | const 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. |