ucommon
|
The Date class uses a julian date representation of the current year, month, and day. More...
#include <datetime.h>
Public Member Functions | |
Date (time_t value) | |
Create a julian date from a time_t type. More... | |
Date (struct tm *object) | |
Create a julian date from a local or gmt date and time. More... | |
Date (const char *pointer, size_t size=0) | |
Create a julian date from a ISO date string of a specified size. More... | |
Date (int year, unsigned month, unsigned day) | |
Create a julian date from an arbitrary year, month, and day. More... | |
Date (const Date &object) | |
Create a julian date object from another object. More... | |
Date () | |
Construct a new julian date with today's date. | |
unsigned | day (void) const |
Get the day of the month of the date. More... | |
unsigned | dow (void) const |
Get the day of the week (0-7). More... | |
long | get (void) const |
Get the date as a number for the object or 0 if invalid. More... | |
bool | is_valid (void) const |
Check if date is valid. More... | |
unsigned | month (void) const |
Get the month of the date (1-12). More... | |
operator bool () const | |
Check if julian date is valid for is() expression. More... | |
operator long () const | |
Casting operator to return date as number. More... | |
bool | operator! () const |
Check if julian date is not valid. More... | |
bool | operator!= (const Date &date) const |
Compare julian dates if not same date. More... | |
String | operator() () const |
Expression operator to return an ISO date string for the current julian date. More... | |
long | operator* () const |
Access julian value. More... | |
Date | operator+ (long days) |
Add days to julian date in an expression. More... | |
Date & | operator++ () |
Increment date by one day. More... | |
Date & | operator+= (long offset) |
Increment date by offset. More... | |
Date | operator- (long days) |
Subtract days from a julian date in an expression. More... | |
long | operator- (const Date &date) |
Operator to compute number of days between two dates. More... | |
Date & | operator-- () |
Decrement date by one day. More... | |
Date & | operator-= (long offset) |
Decrement date by offset. More... | |
bool | operator< (const Date &date) const |
Compare julian date if earlier than another date. More... | |
bool | operator<= (const Date &date) const |
Compare julian date if earlier than or equal to another date. More... | |
Date & | operator= (const Date &date) |
Assign date from another date object. More... | |
bool | operator== (const Date &date) const |
Compare julian dates if same date. More... | |
bool | operator> (const Date &date) const |
Compare julian date if later than another date. More... | |
bool | operator>= (const Date &date) const |
Compare julian date if later than or equal to another date. More... | |
const char * | put (char *buffer) const |
Get a ISO string representation of the date (yyyy-mm-dd). More... | |
void | set (void) |
Set (update) the date with current date. | |
void | set (const char *pointer, size_t size=0) |
Set the julian date based on an ISO date string of specified size. More... | |
time_t | timeref (void) const |
Get a time_t for the julian date if in time_t epoch. More... | |
int | year (void) const |
Get the year of the date. More... | |
virtual | ~Date () |
Destroy julian date object. | |
Static Public Attributes | |
static const size_t | sz_string |
Size of date string field. | |
Protected Member Functions | |
void | set (long year, long month, long day) |
virtual void | update (void) |
A method to use to "post" any changed values when shadowing a mixed object class. More... | |
Protected Attributes | |
long | julian |
The Date class uses a julian date representation of the current year, month, and day.
This is then manipulated in several forms and may be exported as needed.
Definition at line 78 of file datetime.h.
ucommon::Date::Date | ( | time_t | value | ) |
Create a julian date from a time_t type.
value | from time() |
ucommon::Date::Date | ( | struct tm * | object | ) |
Create a julian date from a local or gmt date and time.
object | from DateTime::glt() or gmt(). |
ucommon::Date::Date | ( | const char * | pointer, |
size_t | size = 0 |
||
) |
Create a julian date from a ISO date string of a specified size.
pointer | to ISO date string. |
size | of date field if not null terminated. |
ucommon::Date::Date | ( | int | year, |
unsigned | month, | ||
unsigned | day | ||
) |
Create a julian date from an arbitrary year, month, and day.
year | of date. |
month | of date (1-12). |
day | of month (1-31). |
ucommon::Date::Date | ( | const Date & | object | ) |
Create a julian date object from another object.
object | to copy. |
unsigned ucommon::Date::day | ( | void | ) | const |
Get the day of the month of the date.
unsigned ucommon::Date::dow | ( | void | ) | const |
Get the day of the week (0-7).
long ucommon::Date::get | ( | void | ) | const |
Get the date as a number for the object or 0 if invalid.
bool ucommon::Date::is_valid | ( | void | ) | const |
Check if date is valid.
unsigned ucommon::Date::month | ( | void | ) | const |
Get the month of the date (1-12).
|
inline |
Check if julian date is valid for is() expression.
Definition at line 330 of file datetime.h.
|
inline |
Casting operator to return date as number.
Definition at line 205 of file datetime.h.
|
inline |
Check if julian date is not valid.
Definition at line 323 of file datetime.h.
bool ucommon::Date::operator!= | ( | const Date & | date | ) | const |
Compare julian dates if not same date.
date | to compare with. |
String ucommon::Date::operator() | ( | ) | const |
Expression operator to return an ISO date string for the current julian date.
|
inline |
Date ucommon::Date::operator+ | ( | long | days | ) |
Add days to julian date in an expression.
days | to add. |
Date& ucommon::Date::operator++ | ( | ) |
Increment date by one day.
Date& ucommon::Date::operator+= | ( | long | offset | ) |
Increment date by offset.
offset | to add to julian date. |
Date ucommon::Date::operator- | ( | long | days | ) |
Subtract days from a julian date in an expression.
days | to subtract. |
|
inline |
Operator to compute number of days between two dates.
date | offset for computation. |
Definition at line 267 of file datetime.h.
Date& ucommon::Date::operator-- | ( | ) |
Decrement date by one day.
Date& ucommon::Date::operator-= | ( | long | offset | ) |
Decrement date by offset.
offset | to subtract from julian date. |
bool ucommon::Date::operator< | ( | const Date & | date | ) | const |
Compare julian date if earlier than another date.
date | to compare with. |
bool ucommon::Date::operator<= | ( | const Date & | date | ) | const |
Compare julian date if earlier than or equal to another date.
date | to compare with. |
Assign date from another date object.
date | object to assign from. |
bool ucommon::Date::operator== | ( | const Date & | date | ) | const |
Compare julian dates if same date.
date | to compare with. |
bool ucommon::Date::operator> | ( | const Date & | date | ) | const |
Compare julian date if later than another date.
date | to compare with. |
bool ucommon::Date::operator>= | ( | const Date & | date | ) | const |
Compare julian date if later than or equal to another date.
date | to compare with. |
const char* ucommon::Date::put | ( | char * | buffer | ) | const |
Get a ISO string representation of the date (yyyy-mm-dd).
buffer | to store string. |
void ucommon::Date::set | ( | const char * | pointer, |
size_t | size = 0 |
||
) |
Set the julian date based on an ISO date string of specified size.
pointer | to date string field. |
size | of field if not null terminated. |
time_t ucommon::Date::timeref | ( | void | ) | const |
Get a time_t for the julian date if in time_t epoch.
|
protectedvirtual |
A method to use to "post" any changed values when shadowing a mixed object class.
This is used by DateNumber and string classes.
Reimplemented in ucommon::DateNumber, ucommon::DateTimeString, and ucommon::DateTime.
int ucommon::Date::year | ( | void | ) | const |
Get the year of the date.