DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Attributes | List of all members
DRTProcedureCodeSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTProcedureCodeSequence::Item:

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor More...
 
 Item (const Item &copy)
 copy constructor More...
 
virtual ~Item ()
 destructor
 
Itemoperator= (const Item &copy)
 assigment operator More...
 
void clear ()
 clear all internal member variables
 
OFBool isEmpty ()
 check if item is empty More...
 
OFBool isValid () const
 check if item is valid, i.e. not the empty default item More...
 
OFCondition read (DcmItem &item)
 read elements from sequence item More...
 
OFCondition write (DcmItem &item)
 write elements to sequence item More...
 
OFCondition getCodeMeaning (OFString &value, const signed long pos=0) const
 get CodeMeaning (0008,0104) More...
 
OFCondition getCodeValue (OFString &value, const signed long pos=0) const
 get CodeValue (0008,0100) More...
 
OFCondition getCodingSchemeDesignator (OFString &value, const signed long pos=0) const
 get CodingSchemeDesignator (0008,0102) More...
 
OFCondition getCodingSchemeVersion (OFString &value, const signed long pos=0) const
 get CodingSchemeVersion (0008,0103) More...
 
OFCondition getContextGroupExtensionCreatorUID (OFString &value, const signed long pos=0) const
 get ContextGroupExtensionCreatorUID (0008,010d) More...
 
OFCondition getContextGroupExtensionFlag (OFString &value, const signed long pos=0) const
 get ContextGroupExtensionFlag (0008,010b) More...
 
OFCondition getContextGroupLocalVersion (OFString &value, const signed long pos=0) const
 get ContextGroupLocalVersion (0008,0107) More...
 
OFCondition getContextGroupVersion (OFString &value, const signed long pos=0) const
 get ContextGroupVersion (0008,0106) More...
 
OFCondition getContextIdentifier (OFString &value, const signed long pos=0) const
 get ContextIdentifier (0008,010f) More...
 
OFCondition getContextUID (OFString &value, const signed long pos=0) const
 get ContextUID (0008,0117) More...
 
OFCondition getLongCodeValue (OFString &value, const signed long pos=0) const
 get LongCodeValue (0008,0119) More...
 
OFCondition getMappingResource (OFString &value, const signed long pos=0) const
 get MappingResource (0008,0105) More...
 
OFCondition getMappingResourceName (OFString &value, const signed long pos=0) const
 get MappingResourceName (0008,0122) More...
 
OFCondition getMappingResourceUID (OFString &value, const signed long pos=0) const
 get MappingResourceUID (0008,0118) More...
 
OFCondition getURNCodeValue (OFString &value, const signed long pos=0) const
 get URNCodeValue (0008,0120) More...
 
DRTEquivalentCodeSequencegetEquivalentCodeSequence ()
 get EquivalentCodeSequence (0008,0121) More...
 
const DRTEquivalentCodeSequencegetEquivalentCodeSequence () const
 get EquivalentCodeSequence (0008,0121) More...
 
OFCondition setCodeMeaning (const OFString &value, const OFBool check=OFTrue)
 set CodeMeaning (0008,0104) More...
 
OFCondition setCodeValue (const OFString &value, const OFBool check=OFTrue)
 set CodeValue (0008,0100) More...
 
OFCondition setCodingSchemeDesignator (const OFString &value, const OFBool check=OFTrue)
 set CodingSchemeDesignator (0008,0102) More...
 
OFCondition setCodingSchemeVersion (const OFString &value, const OFBool check=OFTrue)
 set CodingSchemeVersion (0008,0103) More...
 
OFCondition setContextGroupExtensionCreatorUID (const OFString &value, const OFBool check=OFTrue)
 set ContextGroupExtensionCreatorUID (0008,010d) More...
 
OFCondition setContextGroupExtensionFlag (const OFString &value, const OFBool check=OFTrue)
 set ContextGroupExtensionFlag (0008,010b) More...
 
OFCondition setContextGroupLocalVersion (const OFString &value, const OFBool check=OFTrue)
 set ContextGroupLocalVersion (0008,0107) More...
 
OFCondition setContextGroupVersion (const OFString &value, const OFBool check=OFTrue)
 set ContextGroupVersion (0008,0106) More...
 
OFCondition setContextIdentifier (const OFString &value, const OFBool check=OFTrue)
 set ContextIdentifier (0008,010f) More...
 
OFCondition setContextUID (const OFString &value, const OFBool check=OFTrue)
 set ContextUID (0008,0117) More...
 
OFCondition setLongCodeValue (const OFString &value, const OFBool check=OFTrue)
 set LongCodeValue (0008,0119) More...
 
OFCondition setMappingResource (const OFString &value, const OFBool check=OFTrue)
 set MappingResource (0008,0105) More...
 
OFCondition setMappingResourceName (const OFString &value, const OFBool check=OFTrue)
 set MappingResourceName (0008,0122) More...
 
OFCondition setMappingResourceUID (const OFString &value, const OFBool check=OFTrue)
 set MappingResourceUID (0008,0118) More...
 
OFCondition setURNCodeValue (const OFString &value, const OFBool check=OFTrue)
 set URNCodeValue (0008,0120) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmLongString CodeMeaning
 CodeMeaning (0008,0104) vr=LO, vm=1, type=1.
 
DcmShortString CodeValue
 CodeValue (0008,0100) vr=SH, vm=1, type=1C.
 
DcmShortString CodingSchemeDesignator
 CodingSchemeDesignator (0008,0102) vr=SH, vm=1, type=1C.
 
DcmShortString CodingSchemeVersion
 CodingSchemeVersion (0008,0103) vr=SH, vm=1, type=1C.
 
DcmUniqueIdentifier ContextGroupExtensionCreatorUID
 ContextGroupExtensionCreatorUID (0008,010d) vr=UI, vm=1, type=1C.
 
DcmCodeString ContextGroupExtensionFlag
 ContextGroupExtensionFlag (0008,010b) vr=CS, vm=1, type=3.
 
DcmDateTime ContextGroupLocalVersion
 ContextGroupLocalVersion (0008,0107) vr=DT, vm=1, type=1C.
 
DcmDateTime ContextGroupVersion
 ContextGroupVersion (0008,0106) vr=DT, vm=1, type=1C.
 
DcmCodeString ContextIdentifier
 ContextIdentifier (0008,010f) vr=CS, vm=1, type=3.
 
DcmUniqueIdentifier ContextUID
 ContextUID (0008,0117) vr=UI, vm=1, type=3.
 
DRTEquivalentCodeSequence EquivalentCodeSequence
 EquivalentCodeSequence (0008,0121) vr=SQ, vm=1, type=3.
 
DcmUnlimitedCharacters LongCodeValue
 LongCodeValue (0008,0119) vr=UC, vm=1, type=1C.
 
DcmCodeString MappingResource
 MappingResource (0008,0105) vr=CS, vm=1, type=1C.
 
DcmLongString MappingResourceName
 MappingResourceName (0008,0122) vr=LO, vm=1, type=3.
 
DcmUniqueIdentifier MappingResourceUID
 MappingResourceUID (0008,0118) vr=UI, vm=1, type=3.
 
DcmUniversalResourceIdentifierOrLocator URNCodeValue
 URNCodeValue (0008,0120) vr=UR, vm=1, type=1C.
 

Additional Inherited Members

- Protected Member Functions inherited from DRTTypes
virtual ~DRTTypes ()
 destructor. More...
 
- Static Protected Member Functions inherited from DRTTypes
static OFCondition addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement *element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 add given element to the dataset. More...
 
static OFCondition getElementFromDataset (DcmItem &dataset, DcmElement &element)
 get element from dataset More...
 
static OFCondition getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0)
 get string value from element More...
 
static OFCondition getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
 get string value from dataset More...
 
static OFCondition putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
 put string value to dataset More...
 
static OFBool checkElementValue (DcmElement &element, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL)
 check element value for correct value multiplicity and type More...
 
static OFCondition getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 get element from dataset and check it for correct value multiplicity and type. More...
 
static OFCondition getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 get string value from dataset and check it for correct value multiplicity and type. More...
 

Detailed Description

Item class.

Constructor & Destructor Documentation

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item
DRTProcedureCodeSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

OFCondition DRTProcedureCodeSequence::Item::getCodeMeaning ( OFString value,
const signed long  pos = 0 
) const

get CodeMeaning (0008,0104)

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 DRTProcedureCodeSequence::Item::getCodeValue ( OFString value,
const signed long  pos = 0 
) const

get CodeValue (0008,0100)

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 DRTProcedureCodeSequence::Item::getCodingSchemeDesignator ( OFString value,
const signed long  pos = 0 
) const

get CodingSchemeDesignator (0008,0102)

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 DRTProcedureCodeSequence::Item::getCodingSchemeVersion ( OFString value,
const signed long  pos = 0 
) const

get CodingSchemeVersion (0008,0103)

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 DRTProcedureCodeSequence::Item::getContextGroupExtensionCreatorUID ( OFString value,
const signed long  pos = 0 
) const

get ContextGroupExtensionCreatorUID (0008,010d)

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 DRTProcedureCodeSequence::Item::getContextGroupExtensionFlag ( OFString value,
const signed long  pos = 0 
) const

get ContextGroupExtensionFlag (0008,010b)

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 DRTProcedureCodeSequence::Item::getContextGroupLocalVersion ( OFString value,
const signed long  pos = 0 
) const

get ContextGroupLocalVersion (0008,0107)

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 DRTProcedureCodeSequence::Item::getContextGroupVersion ( OFString value,
const signed long  pos = 0 
) const

get ContextGroupVersion (0008,0106)

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 DRTProcedureCodeSequence::Item::getContextIdentifier ( OFString value,
const signed long  pos = 0 
) const

get ContextIdentifier (0008,010f)

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 DRTProcedureCodeSequence::Item::getContextUID ( OFString value,
const signed long  pos = 0 
) const

get ContextUID (0008,0117)

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
DRTEquivalentCodeSequence& DRTProcedureCodeSequence::Item::getEquivalentCodeSequence ( )
inline

get EquivalentCodeSequence (0008,0121)

Returns
reference to sequence element
const DRTEquivalentCodeSequence& DRTProcedureCodeSequence::Item::getEquivalentCodeSequence ( ) const
inline

get EquivalentCodeSequence (0008,0121)

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

get LongCodeValue (0008,0119)

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 DRTProcedureCodeSequence::Item::getMappingResource ( OFString value,
const signed long  pos = 0 
) const

get MappingResource (0008,0105)

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 DRTProcedureCodeSequence::Item::getMappingResourceName ( OFString value,
const signed long  pos = 0 
) const

get MappingResourceName (0008,0122)

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 DRTProcedureCodeSequence::Item::getMappingResourceUID ( OFString value,
const signed long  pos = 0 
) const

get MappingResourceUID (0008,0118)

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 DRTProcedureCodeSequence::Item::getURNCodeValue ( OFString value,
const signed long  pos = 0 
) const

get URNCodeValue (0008,0120)

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
OFBool DRTProcedureCodeSequence::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise
OFBool DRTProcedureCodeSequence::Item::isValid ( ) const

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

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

assigment operator

Parameters
copyitem object to be copied
Returns
reference to this object
OFCondition DRTProcedureCodeSequence::Item::read ( DcmItem item)

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 DRTProcedureCodeSequence::Item::setCodeMeaning ( const OFString value,
const OFBool  check = OFTrue 
)

set CodeMeaning (0008,0104)

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

set CodeValue (0008,0100)

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

set CodingSchemeDesignator (0008,0102)

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

set CodingSchemeVersion (0008,0103)

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

set ContextGroupExtensionCreatorUID (0008,010d)

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 DRTProcedureCodeSequence::Item::setContextGroupExtensionFlag ( const OFString value,
const OFBool  check = OFTrue 
)

set ContextGroupExtensionFlag (0008,010b)

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
OFCondition DRTProcedureCodeSequence::Item::setContextGroupLocalVersion ( const OFString value,
const OFBool  check = OFTrue 
)

set ContextGroupLocalVersion (0008,0107)

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 DRTProcedureCodeSequence::Item::setContextGroupVersion ( const OFString value,
const OFBool  check = OFTrue 
)

set ContextGroupVersion (0008,0106)

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 DRTProcedureCodeSequence::Item::setContextIdentifier ( const OFString value,
const OFBool  check = OFTrue 
)

set ContextIdentifier (0008,010f)

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
OFCondition DRTProcedureCodeSequence::Item::setContextUID ( const OFString value,
const OFBool  check = OFTrue 
)

set ContextUID (0008,0117)

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 DRTProcedureCodeSequence::Item::setLongCodeValue ( const OFString value,
const OFBool  check = OFTrue 
)

set LongCodeValue (0008,0119)

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

set MappingResource (0008,0105)

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
OFCondition DRTProcedureCodeSequence::Item::setMappingResourceName ( const OFString value,
const OFBool  check = OFTrue 
)

set MappingResourceName (0008,0122)

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

set MappingResourceUID (0008,0118)

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 DRTProcedureCodeSequence::Item::setURNCodeValue ( const OFString value,
const OFBool  check = OFTrue 
)

set URNCodeValue (0008,0120)

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

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 Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8