DcmDateTime Class Reference

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

Inheritance diagram for DcmDateTime:

DcmByteString DcmElement DcmObject List of all members.

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 OFCondition copyFrom (const DcmObject &rhs)
 Virtual object copying.
virtual DcmEVR ident () const
 get element type identifier
virtual OFCondition checkValue (const OFString &vm="1-n", const OFBool oldFormat=OFFalse)
 check whether stored value conforms to the VR and to the specified VM
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.
static OFCondition checkStringValue (const OFString &value, const OFString &vm="1-n")
 check whether given string value conforms to the VR "DT" (Date Time) and to the specified VM.

Detailed Description

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

Definition at line 40 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

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

assignment operator

Parameters:
obj element to be assigned/copied
Returns:
reference to this object

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

clone method

Returns:
deep copy of this object

Reimplemented from DcmByteString.

Definition at line 72 of file dcvrdt.h.

References DcmDateTime().

virtual OFCondition DcmDateTime::copyFrom ( const DcmObject &  rhs  )  [virtual]

Virtual object copying.

This method can be used for DcmObject and derived classes to get a deep copy of an object. Internally the assignment operator is called if the given DcmObject parameter is of the same type as "this" object instance. If not, an error is returned. This function permits copying an object by value in a virtual way which therefore is different to just calling the assignment operator of DcmElement which could result in slicing the object.

Parameters:
rhs - [in] The instance to copy from. Has to be of the same class type as "this" object
Returns:
EC_Normal if copying was successful, error 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.

virtual OFCondition DcmDateTime::checkValue ( const OFString &  vm = "1-n",
const OFBool  oldFormat = OFFalse 
) [virtual]

check whether stored value conforms to the VR and to the specified VM

Parameters:
vm value multiplicity (according to the data dictionary) to be checked for. (valid values: "1", "1-2", "1-3", "1-8", "1-99", "1-n", "2", "2-n", "2-2n", "3", "3-n", "3-3n", "4", "6", "9", "16", "32")
oldFormat parameter not used for this VR (only for DA, TM, PN)
Returns:
status of the check, EC_Normal if value is correct, an error code otherwise

Reimplemented from DcmElement.

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.

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

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

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

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

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

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

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

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::checkStringValue ( const OFString &  value,
const OFString &  vm = "1-n" 
) [static]

check whether given string value conforms to the VR "DT" (Date Time) and to the specified VM.

Parameters:
value string value to be checked (possibly multi-valued)
vm value multiplicity (according to the data dictionary) to be checked for. (valid values: "1", "1-2", "1-3", "1-8", "1-99", "1-n", "2", "2-n", "2-2n", "3", "3-n", "3-3n", "4", "6", "9", "16", "32")
Returns:
status of the check, EC_Normal if value is correct, an error code otherwise

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

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1