DCMTK
Version 3.6.7
OFFIS DICOM Toolkit
|
This class provides a collection of date functions. More...
Public Member Functions | |
OFDate () | |
default constructor. More... | |
OFDate (const OFDate &dateVal) | |
copy constructor More... | |
OFDate (const unsigned int year, const unsigned int month, const unsigned int day) | |
constructor with init values More... | |
virtual | ~OFDate () |
destructor | |
virtual OFDate & | operator= (const OFDate &dateVal) |
assignment operator More... | |
virtual OFBool | operator== (const OFDate &dateVal) const |
comparison operator (equal) More... | |
virtual OFBool | operator!= (const OFDate &dateVal) const |
comparison operator (unequal) More... | |
virtual OFBool | operator< (const OFDate &dateVal) const |
comparison operator (less than) More... | |
virtual OFBool | operator<= (const OFDate &dateVal) const |
comparison operator (less than or equal) More... | |
virtual OFBool | operator>= (const OFDate &dateVal) const |
comparison operator (greater than or equal) More... | |
virtual OFBool | operator> (const OFDate &dateVal) const |
comparison operator (greater than) More... | |
virtual void | clear () |
reset the date value. More... | |
virtual OFBool | isValid () const |
check whether the currently stored date value is valid. More... | |
OFBool | setDate (const unsigned int year, const unsigned int month, const unsigned int day) |
set the date value to the specified date. More... | |
OFBool | setYear (const unsigned int year) |
set the date value to the specified year. More... | |
OFBool | setMonth (const unsigned int month) |
set the date value to the specified month. More... | |
OFBool | setDay (const unsigned int day) |
set the date value to the specified day. More... | |
OFBool | setCurrentDate () |
set the date value to the current system date. More... | |
OFBool | setISOFormattedDate (const OFString &formattedDate) |
set the date value to the given ISO formatted date string. More... | |
unsigned int | getYear () const |
get the currently stored year value More... | |
unsigned int | getMonth () const |
get the currently stored month value More... | |
unsigned int | getDay () const |
get the currently stored day value More... | |
OFBool | getISOFormattedDate (OFString &formattedDate, const OFBool showDelimiter=OFTrue) const |
get the current date value in ISO format. More... | |
Static Public Member Functions | |
static OFDate | getCurrentDate () |
get the current system date More... | |
Protected Member Functions | |
OFBool | setCurrentDate (const time_t &tt) |
set the date value to the current system date. More... | |
Static Protected Member Functions | |
static OFBool | isDateValid (const unsigned int year, const unsigned int month, const unsigned int day) |
check whether the given date is valid. More... | |
Private Attributes | |
unsigned int | Year |
currently stored year value | |
unsigned int | Month |
currently stored month value | |
unsigned int | Day |
currently stored day value | |
Friends | |
class | OFDateTime |
allow class OFDateTime to access protected class members | |
This class provides a collection of date functions.
OFDate::OFDate | ( | ) |
default constructor.
Initializes Year, Month and Day to 0.
OFDate::OFDate | ( | const OFDate & | dateVal | ) |
copy constructor
dateVal | date object to be copied |
OFDate::OFDate | ( | const unsigned int | year, |
const unsigned int | month, | ||
const unsigned int | day | ||
) |
constructor with init values
year | year value to be set |
month | month value to be set |
day | day value to be set |
|
virtual |
reset the date value.
Sets the year, month and day to "0". NB: Date becomes invalid.
|
static |
get the current system date
unsigned int OFDate::getDay | ( | ) | const |
get the currently stored day value
OFBool OFDate::getISOFormattedDate | ( | OFString & | formattedDate, |
const OFBool | showDelimiter = OFTrue |
||
) | const |
get the current date value in ISO format.
The two ISO date formats supported by this function are "YYYY-MM-DD" (with delimiters) and "YYYYMMDD" (without delimiters, useful for DICOM date type).
formattedDate | reference to string variable where the result is stored |
showDelimiter | flag, indicating whether to use delimiters ("-") or not |
unsigned int OFDate::getMonth | ( | ) | const |
get the currently stored month value
unsigned int OFDate::getYear | ( | ) | const |
get the currently stored year value
|
staticprotected |
check whether the given date is valid.
Currently, this method only checks whether the month is within the range of 1 to 12 and the day is within the range of 1 to 31. In the future this routine might be enhanced.
year | year value to be checked |
month | month value to be checked |
day | day value to be checked |
|
virtual |
check whether the currently stored date value is valid.
Currently, this method only checks whether the month is within the range of 1 to 12 and the day is within the range of 1 to 31. In the future this routine might be enhanced.
|
virtual |
comparison operator (unequal)
dateVal | date value compared with the current value |
|
virtual |
comparison operator (less than)
dateVal | date value compared with the current value |
|
virtual |
comparison operator (less than or equal)
dateVal | date value compared with the current value |
assignment operator
dateVal | date value to be set |
|
virtual |
comparison operator (equal)
dateVal | date value compared with the current value |
|
virtual |
comparison operator (greater than)
dateVal | date value compared with the current value |
|
virtual |
comparison operator (greater than or equal)
dateVal | date value compared with the current value |
OFBool OFDate::setCurrentDate | ( | ) |
set the date value to the current system date.
This function uses operating system dependent routines. If they are unavailable for some reason the current value is not modified.
|
protected |
set the date value to the current system date.
This function uses operating system dependent routines. If they are unavailable for some reason the current value is not modified.
tt | current system time (as returned by the time() function ) |
OFBool OFDate::setDate | ( | const unsigned int | year, |
const unsigned int | month, | ||
const unsigned int | day | ||
) |
set the date value to the specified date.
Before the new value is set it is checked using the "isValid()" routine.
year | new year value to be set |
month | new month value to be set |
day | new day value to be set |
OFBool OFDate::setDay | ( | const unsigned int | day | ) |
set the date value to the specified day.
Before the new value is set it is checked using the "isValid()" routine.
day | new day value to be set |
OFBool OFDate::setISOFormattedDate | ( | const OFString & | formattedDate | ) |
set the date value to the given ISO formatted date string.
The two ISO date formats supported by this function are "YYYY-MM-DD" (with arbitrary delimiters) and "YYYYMMDD" (without delimiters, useful for DICOM date type).
formattedDate | ISO formatted date value to be set |
OFBool OFDate::setMonth | ( | const unsigned int | month | ) |
set the date value to the specified month.
Before the new value is set it is checked using the "isValid()" routine.
month | new month value to be set |
OFBool OFDate::setYear | ( | const unsigned int | year | ) |
set the date value to the specified year.
Before the new value is set it is checked using the "isValid()" routine.
year | new year value to be set |