DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes
DRTContentItemModifierSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTContentItemModifierSequence::Item:

List of all members.

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor
 Item (const Item &copy)
 copy constructor
virtual ~Item ()
 destructor
Itemoperator= (const Item &copy)
 assigment operator
void clear ()
 clear all internal member variables
OFBool isEmpty ()
 check if item is empty
OFBool isValid () const
 check if item is valid, i.e. not the empty default item
OFCondition read (DcmItem &item)
 read elements from sequence item
OFCondition write (DcmItem &item)
 write elements to sequence item
OFCondition getDate (OFString &value, const signed long pos=0) const
 get Date (0040,a121)
OFCondition getDateTime (OFString &value, const signed long pos=0) const
 get DateTime (0040,a120)
OFCondition getNumericValue (OFString &value, const signed long pos=0) const
 get NumericValue (0040,a30a)
OFCondition getNumericValue (Float64 &value, const unsigned long pos=0) const
 get NumericValue (0040,a30a)
OFCondition getNumericValue (OFVector< Float64 > &value) const
 get NumericValue (0040,a30a)
OFCondition getPersonName (OFString &value, const signed long pos=0) const
 get PersonName (0040,a123)
OFCondition getTextValue (OFString &value, const signed long pos=0) const
 get TextValue (0040,a160)
OFCondition getTime (OFString &value, const signed long pos=0) const
 get Time (0040,a122)
OFCondition getUID (OFString &value, const signed long pos=0) const
 get UID (0040,a124)
OFCondition getValueType (OFString &value, const signed long pos=0) const
 get ValueType (0040,a040)
DRTConceptCodeSequencegetConceptCodeSequence ()
 get ConceptCodeSequence (0040,a168)
const DRTConceptCodeSequencegetConceptCodeSequence () const
 get ConceptCodeSequence (0040,a168)
DRTConceptNameCodeSequencegetConceptNameCodeSequence ()
 get ConceptNameCodeSequence (0040,a043)
const DRTConceptNameCodeSequencegetConceptNameCodeSequence () const
 get ConceptNameCodeSequence (0040,a043)
DRTMeasurementUnitsCodeSequencegetMeasurementUnitsCodeSequence ()
 get MeasurementUnitsCodeSequence (0040,08ea)
const
DRTMeasurementUnitsCodeSequence
getMeasurementUnitsCodeSequence () const
 get MeasurementUnitsCodeSequence (0040,08ea)
OFCondition setDate (const OFString &value, const OFBool check=OFTrue)
 set Date (0040,a121)
OFCondition setDateTime (const OFString &value, const OFBool check=OFTrue)
 set DateTime (0040,a120)
OFCondition setNumericValue (const OFString &value, const OFBool check=OFTrue)
 set NumericValue (0040,a30a)
OFCondition setPersonName (const OFString &value, const OFBool check=OFTrue)
 set PersonName (0040,a123)
OFCondition setTextValue (const OFString &value, const OFBool check=OFTrue)
 set TextValue (0040,a160)
OFCondition setTime (const OFString &value, const OFBool check=OFTrue)
 set Time (0040,a122)
OFCondition setUID (const OFString &value, const OFBool check=OFTrue)
 set UID (0040,a124)
OFCondition setValueType (const OFString &value, const OFBool check=OFTrue)
 set ValueType (0040,a040)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DRTConceptCodeSequence ConceptCodeSequence
 ConceptCodeSequence (0040,a168) vr=SQ, vm=1, type=1C.
DRTConceptNameCodeSequence ConceptNameCodeSequence
 ConceptNameCodeSequence (0040,a043) vr=SQ, vm=1, type=1.
DcmDate Date
 Date (0040,a121) vr=DA, vm=1, type=1C.
DcmDateTime DateTime
 DateTime (0040,a120) vr=DT, vm=1, type=1C.
DRTMeasurementUnitsCodeSequence MeasurementUnitsCodeSequence
 MeasurementUnitsCodeSequence (0040,08ea) vr=SQ, vm=1, type=1C.
DcmDecimalString NumericValue
 NumericValue (0040,a30a) vr=DS, vm=1-n, type=1C.
DcmPersonName PersonName
 PersonName (0040,a123) vr=PN, vm=1, type=1C.
DcmUnlimitedText TextValue
 TextValue (0040,a160) vr=UT, vm=1, type=1C.
DcmTime Time
 Time (0040,a122) vr=TM, vm=1, type=1C.
DcmUniqueIdentifier UID
 UID (0040,a124) vr=UI, vm=1, type=1C.
DcmCodeString ValueType
 ValueType (0040,a040) vr=CS, vm=1, type=1.

Detailed Description

Item class.


Constructor & Destructor Documentation

DRTContentItemModifierSequence::Item::Item ( const OFBool  emptyDefaultItem = OFFalse)

(default) constructor

Parameters:
emptyDefaultItemflag used to mark the empty default item

copy constructor

Parameters:
copyitem object to be copied

Member Function Documentation

get ConceptCodeSequence (0040,a168)

Returns:
reference to sequence element

get ConceptCodeSequence (0040,a168)

Returns:
const reference to sequence element

get ConceptNameCodeSequence (0040,a043)

Returns:
reference to sequence element

get ConceptNameCodeSequence (0040,a043)

Returns:
const reference to sequence element
OFCondition DRTContentItemModifierSequence::Item::getDate ( OFString value,
const signed long  pos = 0 
) const

get Date (0040,a121)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::getDateTime ( OFString value,
const signed long  pos = 0 
) const

get DateTime (0040,a120)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get MeasurementUnitsCodeSequence (0040,08ea)

Returns:
reference to sequence element

get MeasurementUnitsCodeSequence (0040,08ea)

Returns:
const reference to sequence element
OFCondition DRTContentItemModifierSequence::Item::getNumericValue ( OFString value,
const signed long  pos = 0 
) const

get NumericValue (0040,a30a)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::getNumericValue ( Float64 &  value,
const unsigned long  pos = 0 
) const

get NumericValue (0040,a30a)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get NumericValue (0040,a30a)

Parameters:
valuereference to variable in which the value(s) should be stored
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::getPersonName ( OFString value,
const signed long  pos = 0 
) const

get PersonName (0040,a123)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::getTextValue ( OFString value,
const signed long  pos = 0 
) const

get TextValue (0040,a160)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::getTime ( OFString value,
const signed long  pos = 0 
) const

get Time (0040,a122)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::getUID ( OFString value,
const signed long  pos = 0 
) const

get UID (0040,a124)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::getValueType ( OFString value,
const signed long  pos = 0 
) const

get ValueType (0040,a040)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

check if item is empty

Returns:
OFTrue if item is empty, OFFalse otherwise

check if item is valid, i.e. not the empty default item

Returns:
OFTrue if item is valid, OFFalse otherwise
Item& DRTContentItemModifierSequence::Item::operator= ( const Item copy)

assigment operator

Parameters:
copyitem object to be copied

read elements from sequence item

Parameters:
itemreference to DICOM sequence item from which the elements should be read
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::setDate ( const OFString value,
const OFBool  check = OFTrue 
)

set Date (0040,a121)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DA) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::setDateTime ( const OFString value,
const OFBool  check = OFTrue 
)

set DateTime (0040,a120)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DT) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::setNumericValue ( const OFString value,
const OFBool  check = OFTrue 
)

set NumericValue (0040,a30a)

Parameters:
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1-n) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::setPersonName ( const OFString value,
const OFBool  check = OFTrue 
)

set PersonName (0040,a123)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (PN) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::setTextValue ( const OFString value,
const OFBool  check = OFTrue 
)

set TextValue (0040,a160)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (UT) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::setTime ( const OFString value,
const OFBool  check = OFTrue 
)

set Time (0040,a122)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (TM) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::setUID ( const OFString value,
const OFBool  check = OFTrue 
)

set UID (0040,a124)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (UI) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTContentItemModifierSequence::Item::setValueType ( const OFString value,
const OFBool  check = OFTrue 
)

set ValueType (0040,a040)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

write elements to sequence item

Parameters:
itemreference to DICOM sequence item to which the elements should be written
Returns:
status, EC_Normal if successful, an error code otherwise

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


Generated on Tue May 15 2012 for DCMTK Version 3.6.1 20120515 by Doxygen 1.7.5.1-20111027