DcmDateTime Class Reference

a class representing the DICOM value representation 'Date Time' (DT) More...

Inheritance diagram for DcmDateTime:


Public Member Functions
	DcmDateTime (const DcmTag &tag, const Uint32 len=0)
	constructor.
	DcmDateTime (const DcmDateTime &old)
	copy constructor
virtual	~DcmDateTime ()
	destructor
DcmDateTime &	operator= (const DcmDateTime &obj)
	assignment operator
virtual DcmObject *	clone () const
	clone method
virtual DcmEVR	ident () const
	get element type identifier
virtual OFCondition	getOFString (OFString &stringValue, const unsigned long pos, OFBool normalize=OFTrue)
	get a copy of a particular string component
OFCondition	setCurrentDateTime (const OFBool seconds=OFTrue, const OFBool fraction=OFFalse, const OFBool timeZone=OFFalse)
	set the element value to the current system date and time.
OFCondition	setOFDateTime (const OFDateTime &dateTimeValue)
	set the element value to the given date and time
OFCondition	getOFDateTime (OFDateTime &dateTimeValue, const unsigned long pos=0)
	get the current element value in OFDateTime format.
OFCondition	getISOFormattedDateTime (OFString &formattedDateTime, const unsigned long pos=0, const OFBool seconds=OFTrue, const OFBool fraction=OFFalse, const OFBool timeZone=OFTrue, const OFBool createMissingPart=OFFalse)
	get the current element value in ISO date/time format.
OFCondition	getISOFormattedDateTime (OFString &formattedDateTime, const unsigned long pos, const OFBool seconds, const OFBool fraction, const OFBool timeZone, const OFBool createMissingPart, const OFString &dateTimeSeparator)
	get the current element value in ISO date/time format.
Static Public Member Functions
static OFCondition	getCurrentDateTime (OFString &dicomDateTime, const OFBool seconds=OFTrue, const OFBool fraction=OFFalse, const OFBool timeZone=OFFalse)
	get the current system date and time.
static OFCondition	getDicomDateTimeFromOFDateTime (const OFDateTime &dateTimeValue, OFString &dicomDateTime, const OFBool seconds=OFTrue, const OFBool fraction=OFFalse, const OFBool timeZone=OFFalse)
	get the specified OFDateTime value in DICOM format.
static OFCondition	getOFDateTimeFromString (const OFString &dicomDateTime, OFDateTime &dateTimeValue)
	get the specified DICOM date and time value in OFDateTime format.
static OFCondition	getISOFormattedDateTimeFromString (const OFString &dicomDateTime, OFString &formattedDateTime, const OFBool seconds=OFTrue, const OFBool fraction=OFFalse, const OFBool timeZone=OFTrue, const OFBool createMissingPart=OFFalse)
	get the specified DICOM datetime value in ISO format.
static OFCondition	getISOFormattedDateTimeFromString (const OFString &dicomDateTime, OFString &formattedDateTime, const OFBool seconds, const OFBool fraction, const OFBool timeZone, const OFBool createMissingPart, const OFString &dateTimeSeparator)
	get the specified DICOM datetime value in ISO format.

Detailed Description

a class representing the DICOM value representation 'Date Time' (DT)

Definition at line 45 of file dcvrdt.h.

Constructor & Destructor Documentation

DcmDateTime::DcmDateTime ( const DcmTag & tag,

const Uint32 len = 0

)

constructor.
Create new element from given tag and length.
Parameters:

tag DICOM tag for the new element

len value length for the new element

Referenced by clone().

DcmDateTime::DcmDateTime ( const DcmDateTime & old )

copy constructor

Parameters:

old element to be copied

Member Function Documentation

virtual DcmObject* DcmDateTime::clone ( ) const [inline, virtual]

clone method

Returns:
deep copy of this object

Reimplemented from DcmByteString.
Definition at line 77 of file dcvrdt.h.
References DcmDateTime().

static OFCondition DcmDateTime::getCurrentDateTime ( OFString & dicomDateTime,

const OFBool seconds = OFTrue,

const OFBool fraction = OFFalse,

const OFBool timeZone = OFFalse

) [static]

get the current system date and time.
The DICOM DT format supported by this function is "YYYYMMDDHHMM[SS[.FFFFFF]][&ZZZZ]" where the brackets enclose optional parts. If the current system date/time or parts of it are unavailable the corresponding values are set to "0" and an error code is returned - in fact, the date is set to "19000101" if unavailable.
Parameters:

dicomDateTime reference to string variable where the result is stored

seconds add optional seconds ("SS") if OFTrue

fraction add optional fractional part of a second (".FFFFFF") if OFTrue (requires parameter 'seconds' to be also OFTrue)

timeZone add optional time zone ("&ZZZZ" where "&" is "+" or "-") if OFTrue. The time zone is given as the offset (hours and minutes) from Coordinated Universal Time (UTC).

Returns:
EC_Normal upon success, an error code otherwise

static OFCondition DcmDateTime::getDicomDateTimeFromOFDateTime ( const OFDateTime & dateTimeValue,

OFString & dicomDateTime,

const OFBool seconds = OFTrue,

const OFBool fraction = OFFalse,

const OFBool timeZone = OFFalse

) [static]

get the specified OFDateTime value in DICOM format.
The DICOM DT format supported by this function is "YYYYMMDDHHMM[SS[.FFFFFF]][&ZZZZ]" where the brackets enclose optional parts. If the current system date/time or parts of it are unavailable the corresponding values are set to "0" and an error code is returned - in fact, the date is set to "19000101" if unavailable.
Parameters:

dateTimeValue date and time to be converted to DICOM format

dicomDateTime reference to string variable where the result is stored

seconds add optional seconds ("SS") if OFTrue

fraction add optional fractional part of a second (".FFFFFF") if OFTrue (requires parameter 'seconds' to be also OFTrue)

timeZone add optional time zone ("&ZZZZ" where "&" is "+" or "-") if OFTrue. The time zone is given as the offset (hours and minutes) from Coordinated Universal Time (UTC).

Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmDateTime::getISOFormattedDateTime ( OFString & formattedDateTime,

const unsigned long pos,

const OFBool seconds,

const OFBool fraction,

const OFBool timeZone,

const OFBool createMissingPart,

const OFString & dateTimeSeparator

)

get the current element value in ISO date/time format.
Same as above but allows to specify the separator between date and time value. Only required since Sun CC 2.0.1 compiler does not support default parameter values for "complex types" like OFString. Reports the error message: "Sorry not implemented" :-/
Parameters:

formattedDateTime reference to string variable where the result is stored

pos index of the element component in case of value multiplicity (0..vm-1)

seconds add optional seconds (":SS") if OFTrue

fraction add optional fractional part of a second (".FFFFFF") if OFTrue (requires parameter 'seconds' to be also OFTrue)

timeZone add optional time zone ("&HH:MM" where "&" is "+" or "-") if OFTrue. The time zone is given as the offset (hours and minutes) from Coordinated Universal Time (UTC). Please note that the formatted time output is not adapted to the local time if the time zone is omitted.

createMissingPart if OFTrue create optional parts (seconds, fractional part of a seconds and/or time zone) if absent in the element value

dateTimeSeparator separator between ISO date and time value (default: " ")

Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmDateTime::getISOFormattedDateTime ( OFString & formattedDateTime,

const unsigned long pos = 0,

const OFBool seconds = OFTrue,

const OFBool fraction = OFFalse,

const OFBool timeZone = OFTrue,

const OFBool createMissingPart = OFFalse

)

get the current element value in ISO date/time format.
The ISO date/time format supported by this function is "YYYY-MM-DD HH:MM[:SS[.FFFFFF]] [&HH:MM]" where the brackets enclose optional parts. Please note that the element value is expected to be in valid DICOM DT format ("YYYYMMDD[HH[MM[SS[.FFFFFF]]]][&ZZZZ]"). If this function fails the result variable 'formattedDateTime' is cleared automatically.
Parameters:

formattedDateTime reference to string variable where the result is stored

pos index of the element component in case of value multiplicity (0..vm-1)

seconds add optional seconds (":SS") if OFTrue

fraction add optional fractional part of a second (".FFFFFF") if OFTrue (requires parameter 'seconds' to be also OFTrue)

timeZone add optional time zone ("&HH:MM" where "&" is "+" or "-") if OFTrue. The time zone is given as the offset (hours and minutes) from Coordinated Universal Time (UTC). Please note that the formatted time output is not adapted to the local time if the time zone is omitted.

createMissingPart if OFTrue create optional parts (seconds, fractional part of a seconds and/or time zone) if absent in the element value

Returns:
EC_Normal upon success, an error code otherwise

static OFCondition DcmDateTime::getISOFormattedDateTimeFromString ( const OFString & dicomDateTime,

OFString & formattedDateTime,

const OFBool seconds,

const OFBool fraction,

const OFBool timeZone,

const OFBool createMissingPart,

const OFString & dateTimeSeparator

) [static]

get the specified DICOM datetime value in ISO format.
Same as above but allows to specify the separator between date and time value. Only required since Sun CC 2.0.1 compiler does not support default parameter values for "complex types" like OFString. Reports the error message: "Sorry not implemented" :-/
Parameters:

dicomDateTime string value in DICOM DT format to be converted to ISO format

formattedDateTime reference to string variable where the result is stored

seconds add optional seconds (":SS") if OFTrue

fraction add optional fractional part of a second (".FFFFFF") if OFTrue (requires parameter 'seconds' to be also OFTrue)

timeZone add optional time zone ("&HH:MM" where "&" is "+" or "-") if OFTrue. The time zone is given as the offset (hours and minutes) from the Coordinated Universal Time (UTC). Please note that the formatted time output is not adapted to the local time if the time zone is omitted.

createMissingPart if OFTrue create optional parts (seconds, fractional part of a seconds and/or time zone) if absent in the element value

dateTimeSeparator separator between ISO date and time value (default: " ")

Returns:
EC_Normal upon success, an error code otherwise

static OFCondition DcmDateTime::getISOFormattedDateTimeFromString ( const OFString & dicomDateTime,

OFString & formattedDateTime,

const OFBool seconds = OFTrue,

const OFBool fraction = OFFalse,

const OFBool timeZone = OFTrue,

const OFBool createMissingPart = OFFalse

) [static]

get the specified DICOM datetime value in ISO format.
The ISO date/time format supported by this function is "YYYY-MM-DD HH:MM[:SS[.FFFFFF]] [&HH:MM]" where the brackets enclose optional parts. Please note that the specified value is expected to be in valid DICOM DT format ("YYYYMMDD[HH[MM[SS[.FFFFFF]]]][&ZZZZ]"). If this function fails the result variable 'formattedDateTime' is cleared automatically.
Parameters:

dicomDateTime string value in DICOM DT format to be converted to ISO format

formattedDateTime reference to string variable where the result is stored

seconds add optional seconds (":SS") if OFTrue

fraction add optional fractional part of a second (".FFFFFF") if OFTrue (requires parameter 'seconds' to be also OFTrue)

timeZone add optional time zone ("&HH:MM" where "&" is "+" or "-") if OFTrue. The time zone is given as the offset (hours and minutes) from the Coordinated Universal Time (UTC). Please note that the formatted time output is not adapted to the local time if the time zone is omitted.

createMissingPart if OFTrue create optional parts (seconds, fractional part of a seconds and/or time zone) if absent in the element value

Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmDateTime::getOFDateTime ( OFDateTime & dateTimeValue,

const unsigned long pos = 0

)

get the current element value in OFDateTime format.
Please note that the element value is expected to be in valid DICOM DT format ("YYYYMMDD[HH[MM[SS[.FFFFFF]]]][&ZZZZ]"). If the optional time zone ("&ZZZZ") is missing the local time zone is used. If this function fails the result variable 'dateTimeValue' is cleared automatically.
Parameters:

dateTimeValue reference to OFDateTime variable where the result is stored

pos index of the element component in case of value multiplicity (0..vm-1)

Returns:
EC_Normal upon success, an error code otherwise

static OFCondition DcmDateTime::getOFDateTimeFromString ( const OFString & dicomDateTime,

OFDateTime & dateTimeValue

) [static]

get the specified DICOM date and time value in OFDateTime format.
Please note that the element value is expected to be in valid DICOM DT format ("YYYYMMDD[HH[MM[SS[.FFFFFF]]]][&ZZZZ]"). If the optional time zone ("&ZZZZ") is missing the local time zone is used. If this function fails the result variable 'dateTimeValue' is cleared automatically.
Parameters:

dicomDateTime string value in DICOM DT format to be converted to ISO format

dateTimeValue reference to OFDateTime variable where the result is stored

Returns:
EC_Normal upon success, an error code otherwise

virtual OFCondition DcmDateTime::getOFString ( OFString & stringValue,

const unsigned long pos,

OFBool normalize = OFTrue

) [virtual]

get a copy of a particular string component

Parameters:

stringValue 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

Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmByteString.

virtual DcmEVR DcmDateTime::ident ( ) const [virtual]

get element type identifier

Returns:
type identifier of this class (EVR_DT)

Reimplemented from DcmByteString.

DcmDateTime& DcmDateTime::operator= ( const DcmDateTime & obj )

assignment operator

Parameters:

obj element to be assigned/copied

Returns:
reference to this object

OFCondition DcmDateTime::setCurrentDateTime ( const OFBool seconds = OFTrue,

const OFBool fraction = OFFalse,

const OFBool timeZone = OFFalse

)

set the element value to the current system date and time.
The DICOM DT format supported by this function is "YYYYMMDDHHMM[SS[.FFFFFF]][&ZZZZ]" where the brackets enclose optional parts. If the current system date/time or parts of it are unavailable the corresponding values are set to "0" and an error code is returned - in fact, the date is set to "19000101" if unavailable.
Parameters:

seconds add optional seconds ("SS") if OFTrue

fraction add optional fractional part of a second (".FFFFFF") if OFTrue (requires parameter 'seconds' to be also OFTrue)

timeZone add optional time zone ("&ZZZZ" where "&" is "+" or "-") if OFTrue. The time zone is given as the offset (hours and minutes) from Coordinated Universal Time (UTC).

Returns:
EC_Normal upon success, an error code otherwise

OFCondition DcmDateTime::setOFDateTime ( const OFDateTime & dateTimeValue )

set the element value to the given date and time

Parameters:

dateTimeValue date to be set (should be a valid date and time)

Returns:
EC_Normal upon success, an error code otherwise

The documentation for this class was generated from the following file:

dcmdata/include/dcmtk/dcmdata/dcvrdt.h

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5

DcmDateTime Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation