a class representing the DICOM value representation 'Date' (DA) More...
Public Member Functions | |
DcmDate (const DcmTag &tag, const Uint32 len=0) | |
constructor. | |
DcmDate (const DcmDate &old) | |
copy constructor | |
virtual | ~DcmDate () |
destructor | |
DcmDate & | operator= (const DcmDate &obj) |
assignment operator | |
virtual DcmObject * | clone () const |
clone method | |
virtual DcmEVR | ident () const |
get element type identifier | |
virtual OFCondition | getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue) |
get a copy of a particular string component | |
OFCondition | setCurrentDate () |
set the element value to the current system date. | |
OFCondition | setOFDate (const OFDate &dateValue) |
set the element value to the given date | |
OFCondition | getOFDate (OFDate &dateValue, const unsigned long pos=0, const OFBool supportOldFormat=OFTrue) |
get the current element value in OFDate format. | |
OFCondition | getISOFormattedDate (OFString &formattedDate, const unsigned long pos=0, const OFBool supportOldFormat=OFTrue) |
get the current element value in ISO date format. | |
Static Public Member Functions | |
static OFCondition | getCurrentDate (OFString &dicomDate) |
get the current system date. | |
static OFCondition | getDicomDateFromOFDate (const OFDate &dateValue, OFString &dicomDate) |
get the specified OFDate value in DICOM format. | |
static OFCondition | getOFDateFromString (const OFString &dicomDate, OFDate &dateValue, const OFBool supportOldFormat=OFTrue) |
get the specified DICOM date value in OFDate format. | |
static OFCondition | getISOFormattedDateFromString (const OFString &dicomDate, OFString &formattedDate, const OFBool supportOldFormat=OFTrue) |
get the specified DICOM date value in ISO format. |
a class representing the DICOM value representation 'Date' (DA)
Definition at line 46 of file dcvrda.h.
DcmDate::DcmDate | ( | const DcmTag & | tag, | |
const Uint32 | len = 0 | |||
) |
constructor.
Create new element from given tag and length.
tag | DICOM tag for the new element | |
len | value length for the new element |
Referenced by clone().
DcmDate::DcmDate | ( | const DcmDate & | old | ) |
copy constructor
old | element to be copied |
virtual DcmObject* DcmDate::clone | ( | ) | const [inline, virtual] |
clone method
Reimplemented from DcmByteString.
Definition at line 78 of file dcvrda.h.
References DcmDate().
static OFCondition DcmDate::getCurrentDate | ( | OFString & | dicomDate | ) | [static] |
get the current system date.
The DICOM DA format supported by this function is "YYYYMMDD". If the current system date is unavailable the date is set to "19000101" and an error code is returned.
dicomDate | reference to string variable where the result is stored |
static OFCondition DcmDate::getDicomDateFromOFDate | ( | const OFDate & | dateValue, | |
OFString & | dicomDate | |||
) | [static] |
get the specified OFDate value in DICOM format.
The DICOM DA format supported by this function is "YYYYMMDD". If the specified date is invalid the date is set to "19000101" and an error code is returned.
dateValue | date to be converted to DICOM format | |
dicomDate | reference to string variable where the result is stored |
OFCondition DcmDate::getISOFormattedDate | ( | OFString & | formattedDate, | |
const unsigned long | pos = 0 , |
|||
const OFBool | supportOldFormat = OFTrue | |||
) |
get the current element value in ISO date format.
The ISO date format supported by this function is "YYYY-MM-DD". Please note that the element value is expected to be in valid DICOM DA format ("YYYYMMDD", "YYYY.MM.DD" is also supported for reasons of backward compatibility). If this function fails the result variable 'formattedDate' is cleared automatically.
formattedDate | reference to string variable where the result is stored | |
pos | index of the element component in case of value multiplicity (0..vm-1) | |
supportOldFormat | if OFTrue support old (prior V3.0) date format (see above) |
static OFCondition DcmDate::getISOFormattedDateFromString | ( | const OFString & | dicomDate, | |
OFString & | formattedDate, | |||
const OFBool | supportOldFormat = OFTrue | |||
) | [static] |
get the specified DICOM date value in ISO format.
The ISO date format supported by this function is "YYYY-MM-DD". Please note that the specified value is expected to be in valid DICOM DA format ("YYYYMMDD", "YYYY.MM.DD" is also supported for reasons of backward compatibility). If this function fails the result variable 'formattedDate' is cleared automatically.
dicomDate | string value in DICOM DA format to be converted to ISO format | |
formattedDate | reference to string variable where the result is stored | |
supportOldFormat | if OFTrue support old (prior V3.0) date format (see above) |
OFCondition DcmDate::getOFDate | ( | OFDate & | dateValue, | |
const unsigned long | pos = 0 , |
|||
const OFBool | supportOldFormat = OFTrue | |||
) |
get the current element value in OFDate format.
Please note that the element value is expected to be in valid DICOM DA format ("YYYYMMDD", "YYYY.MM.DD" is also supported for reasons of backward compatibility). If this function fails the result variable 'dateValue' is cleared automatically.
dateValue | reference to OFDate variable where the result is stored | |
pos | index of the element component in case of value multiplicity (0..vm-1) | |
supportOldFormat | if OFTrue support old (prior V3.0) date format (see above) |
static OFCondition DcmDate::getOFDateFromString | ( | const OFString & | dicomDate, | |
OFDate & | dateValue, | |||
const OFBool | supportOldFormat = OFTrue | |||
) | [static] |
get the specified DICOM date value in OFDate format.
Please note that the specified value is expected to be in valid DICOM DA format ("YYYYMMDD", "YYYY.MM.DD" is also supported for reasons of backward compatibility). If this function fails the result variable 'dateValue' is cleared automatically.
dicomDate | string value in DICOM DA format to be converted to ISO format | |
dateValue | reference to OFDate variable where the result is stored | |
supportOldFormat | if OFTrue support old (prior V3.0) date format (see above) |
virtual OFCondition DcmDate::getOFString | ( | OFString & | stringVal, | |
const unsigned long | pos, | |||
OFBool | normalize = OFTrue | |||
) | [virtual] |
get a copy of a particular string component
stringVal | variable in which the result value is stored | |
pos | index of the value in case of multi-valued elements (0..vm-1) | |
normalize | delete trailing spaces if OFTrue |
Reimplemented from DcmByteString.
virtual DcmEVR DcmDate::ident | ( | ) | const [virtual] |
get element type identifier
Reimplemented from DcmByteString.
assignment operator
obj | element to be assigned/copied |
Reimplemented from DcmByteString.
OFCondition DcmDate::setCurrentDate | ( | ) |
set the element value to the current system date.
The DICOM DA format supported by this function is "YYYYMMDD". If the current system date is unavailable the date is set to "19000101" and an error code is returned.
OFCondition DcmDate::setOFDate | ( | const OFDate & | dateValue | ) |
set the element value to the given date
dateValue | date to be set (should be a valid date) |