DCMTK Version 3.6.8
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes | List of all members
DRTRTROIObservationsSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTRTROIObservationsSequence::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)
 assignment 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 getMaterialID (OFString &value, const signed long pos=0) const
 get MaterialID (300a,00e1) More...
 
OFCondition getObservationNumber (OFString &value, const signed long pos=0) const
 get ObservationNumber (3006,0082) More...
 
OFCondition getObservationNumber (Sint32 &value, const unsigned long pos=0) const
 get ObservationNumber (3006,0082) More...
 
OFCondition getROIInterpreter (OFString &value, const signed long pos=0) const
 get ROIInterpreter (3006,00a6) More...
 
OFCondition getRTROIInterpretedType (OFString &value, const signed long pos=0) const
 get RTROIInterpretedType (3006,00a4) More...
 
OFCondition getReferencedROINumber (OFString &value, const signed long pos=0) const
 get ReferencedROINumber (3006,0084) More...
 
OFCondition getReferencedROINumber (Sint32 &value, const unsigned long pos=0) const
 get ReferencedROINumber (3006,0084) More...
 
DRTAnatomicRegionSequencegetAnatomicRegionSequence ()
 get AnatomicRegionSequence (0008,2218) More...
 
const DRTAnatomicRegionSequencegetAnatomicRegionSequence () const
 get AnatomicRegionSequence (0008,2218) More...
 
DRTPrimaryAnatomicStructureSequencegetPrimaryAnatomicStructureSequence ()
 get PrimaryAnatomicStructureSequence (0008,2228) More...
 
const DRTPrimaryAnatomicStructureSequencegetPrimaryAnatomicStructureSequence () const
 get PrimaryAnatomicStructureSequence (0008,2228) More...
 
DRTROIPhysicalPropertiesSequencegetROIPhysicalPropertiesSequence ()
 get ROIPhysicalPropertiesSequence (3006,00b0) More...
 
const DRTROIPhysicalPropertiesSequencegetROIPhysicalPropertiesSequence () const
 get ROIPhysicalPropertiesSequence (3006,00b0) More...
 
DRTRTROIIdentificationCodeSequencegetRTROIIdentificationCodeSequence ()
 get RTROIIdentificationCodeSequence (3006,0086) More...
 
const DRTRTROIIdentificationCodeSequencegetRTROIIdentificationCodeSequence () const
 get RTROIIdentificationCodeSequence (3006,0086) More...
 
DRTRTRelatedROISequencegetRTRelatedROISequence ()
 get RTRelatedROISequence (3006,0030) More...
 
const DRTRTRelatedROISequencegetRTRelatedROISequence () const
 get RTRelatedROISequence (3006,0030) More...
 
DRTRelatedRTROIObservationsSequencegetRelatedRTROIObservationsSequence ()
 get RelatedRTROIObservationsSequence (3006,00a0) More...
 
const DRTRelatedRTROIObservationsSequencegetRelatedRTROIObservationsSequence () const
 get RelatedRTROIObservationsSequence (3006,00a0) More...
 
DRTSegmentedPropertyCategoryCodeSequencegetSegmentedPropertyCategoryCodeSequence ()
 get SegmentedPropertyCategoryCodeSequence (0062,0003) More...
 
const DRTSegmentedPropertyCategoryCodeSequencegetSegmentedPropertyCategoryCodeSequence () const
 get SegmentedPropertyCategoryCodeSequence (0062,0003) More...
 
DRTTherapeuticRoleCategoryCodeSequencegetTherapeuticRoleCategoryCodeSequence ()
 get TherapeuticRoleCategoryCodeSequence (3010,0064) More...
 
const DRTTherapeuticRoleCategoryCodeSequencegetTherapeuticRoleCategoryCodeSequence () const
 get TherapeuticRoleCategoryCodeSequence (3010,0064) More...
 
DRTTherapeuticRoleTypeCodeSequencegetTherapeuticRoleTypeCodeSequence ()
 get TherapeuticRoleTypeCodeSequence (3010,0065) More...
 
const DRTTherapeuticRoleTypeCodeSequencegetTherapeuticRoleTypeCodeSequence () const
 get TherapeuticRoleTypeCodeSequence (3010,0065) More...
 
OFCondition setMaterialID (const OFString &value, const OFBool check=OFTrue)
 set MaterialID (300a,00e1) More...
 
OFCondition setObservationNumber (const OFString &value, const OFBool check=OFTrue)
 set ObservationNumber (3006,0082) More...
 
OFCondition setROIInterpreter (const OFString &value, const OFBool check=OFTrue)
 set ROIInterpreter (3006,00a6) More...
 
OFCondition setRTROIInterpretedType (const OFString &value, const OFBool check=OFTrue)
 set RTROIInterpretedType (3006,00a4) More...
 
OFCondition setReferencedROINumber (const OFString &value, const OFBool check=OFTrue)
 set ReferencedROINumber (3006,0084) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DRTAnatomicRegionSequence AnatomicRegionSequence
 AnatomicRegionSequence (0008,2218) vr=SQ, vm=1, type=3.
 
DcmShortString MaterialID
 MaterialID (300a,00e1) vr=SH, vm=1, type=3.
 
DcmIntegerString ObservationNumber
 ObservationNumber (3006,0082) vr=IS, vm=1, type=1.
 
DRTPrimaryAnatomicStructureSequence PrimaryAnatomicStructureSequence
 PrimaryAnatomicStructureSequence (0008,2228) vr=SQ, vm=1, type=3.
 
DcmPersonName ROIInterpreter
 ROIInterpreter (3006,00a6) vr=PN, vm=1, type=2.
 
DRTROIPhysicalPropertiesSequence ROIPhysicalPropertiesSequence
 ROIPhysicalPropertiesSequence (3006,00b0) vr=SQ, vm=1, type=3.
 
DRTRTROIIdentificationCodeSequence RTROIIdentificationCodeSequence
 RTROIIdentificationCodeSequence (3006,0086) vr=SQ, vm=1, type=3.
 
DcmCodeString RTROIInterpretedType
 RTROIInterpretedType (3006,00a4) vr=CS, vm=1, type=2.
 
DRTRTRelatedROISequence RTRelatedROISequence
 RTRelatedROISequence (3006,0030) vr=SQ, vm=1, type=3.
 
DcmIntegerString ReferencedROINumber
 ReferencedROINumber (3006,0084) vr=IS, vm=1, type=1.
 
DRTRelatedRTROIObservationsSequence RelatedRTROIObservationsSequence
 RelatedRTROIObservationsSequence (3006,00a0) vr=SQ, vm=1, type=3.
 
DRTSegmentedPropertyCategoryCodeSequence SegmentedPropertyCategoryCodeSequence
 SegmentedPropertyCategoryCodeSequence (0062,0003) vr=SQ, vm=1, type=3.
 
DRTTherapeuticRoleCategoryCodeSequence TherapeuticRoleCategoryCodeSequence
 TherapeuticRoleCategoryCodeSequence (3010,0064) vr=SQ, vm=1, type=3.
 
DRTTherapeuticRoleTypeCodeSequence TherapeuticRoleTypeCodeSequence
 TherapeuticRoleTypeCodeSequence (3010,0065) vr=SQ, vm=1, type=3.
 

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

◆ Item() [1/2]

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item

◆ Item() [2/2]

DRTRTROIObservationsSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

◆ getAnatomicRegionSequence() [1/2]

DRTAnatomicRegionSequence & DRTRTROIObservationsSequence::Item::getAnatomicRegionSequence ( )
inline

get AnatomicRegionSequence (0008,2218)

Returns
reference to sequence element

◆ getAnatomicRegionSequence() [2/2]

const DRTAnatomicRegionSequence & DRTRTROIObservationsSequence::Item::getAnatomicRegionSequence ( ) const
inline

get AnatomicRegionSequence (0008,2218)

Returns
const reference to sequence element

◆ getMaterialID()

OFCondition DRTRTROIObservationsSequence::Item::getMaterialID ( OFString value,
const signed long  pos = 0 
) const

get MaterialID (300a,00e1)

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

◆ getObservationNumber() [1/2]

OFCondition DRTRTROIObservationsSequence::Item::getObservationNumber ( OFString value,
const signed long  pos = 0 
) const

get ObservationNumber (3006,0082)

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

◆ getObservationNumber() [2/2]

OFCondition DRTRTROIObservationsSequence::Item::getObservationNumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get ObservationNumber (3006,0082)

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

◆ getPrimaryAnatomicStructureSequence() [1/2]

DRTPrimaryAnatomicStructureSequence & DRTRTROIObservationsSequence::Item::getPrimaryAnatomicStructureSequence ( )
inline

get PrimaryAnatomicStructureSequence (0008,2228)

Returns
reference to sequence element

◆ getPrimaryAnatomicStructureSequence() [2/2]

const DRTPrimaryAnatomicStructureSequence & DRTRTROIObservationsSequence::Item::getPrimaryAnatomicStructureSequence ( ) const
inline

get PrimaryAnatomicStructureSequence (0008,2228)

Returns
const reference to sequence element

◆ getReferencedROINumber() [1/2]

OFCondition DRTRTROIObservationsSequence::Item::getReferencedROINumber ( OFString value,
const signed long  pos = 0 
) const

get ReferencedROINumber (3006,0084)

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

◆ getReferencedROINumber() [2/2]

OFCondition DRTRTROIObservationsSequence::Item::getReferencedROINumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get ReferencedROINumber (3006,0084)

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

◆ getRelatedRTROIObservationsSequence() [1/2]

DRTRelatedRTROIObservationsSequence & DRTRTROIObservationsSequence::Item::getRelatedRTROIObservationsSequence ( )
inline

get RelatedRTROIObservationsSequence (3006,00a0)

Returns
reference to sequence element

◆ getRelatedRTROIObservationsSequence() [2/2]

const DRTRelatedRTROIObservationsSequence & DRTRTROIObservationsSequence::Item::getRelatedRTROIObservationsSequence ( ) const
inline

get RelatedRTROIObservationsSequence (3006,00a0)

Returns
const reference to sequence element

◆ getROIInterpreter()

OFCondition DRTRTROIObservationsSequence::Item::getROIInterpreter ( OFString value,
const signed long  pos = 0 
) const

get ROIInterpreter (3006,00a6)

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

◆ getROIPhysicalPropertiesSequence() [1/2]

DRTROIPhysicalPropertiesSequence & DRTRTROIObservationsSequence::Item::getROIPhysicalPropertiesSequence ( )
inline

get ROIPhysicalPropertiesSequence (3006,00b0)

Returns
reference to sequence element

◆ getROIPhysicalPropertiesSequence() [2/2]

const DRTROIPhysicalPropertiesSequence & DRTRTROIObservationsSequence::Item::getROIPhysicalPropertiesSequence ( ) const
inline

get ROIPhysicalPropertiesSequence (3006,00b0)

Returns
const reference to sequence element

◆ getRTRelatedROISequence() [1/2]

DRTRTRelatedROISequence & DRTRTROIObservationsSequence::Item::getRTRelatedROISequence ( )
inline

get RTRelatedROISequence (3006,0030)

Returns
reference to sequence element

◆ getRTRelatedROISequence() [2/2]

const DRTRTRelatedROISequence & DRTRTROIObservationsSequence::Item::getRTRelatedROISequence ( ) const
inline

get RTRelatedROISequence (3006,0030)

Returns
const reference to sequence element

◆ getRTROIIdentificationCodeSequence() [1/2]

DRTRTROIIdentificationCodeSequence & DRTRTROIObservationsSequence::Item::getRTROIIdentificationCodeSequence ( )
inline

get RTROIIdentificationCodeSequence (3006,0086)

Returns
reference to sequence element

◆ getRTROIIdentificationCodeSequence() [2/2]

const DRTRTROIIdentificationCodeSequence & DRTRTROIObservationsSequence::Item::getRTROIIdentificationCodeSequence ( ) const
inline

get RTROIIdentificationCodeSequence (3006,0086)

Returns
const reference to sequence element

◆ getRTROIInterpretedType()

OFCondition DRTRTROIObservationsSequence::Item::getRTROIInterpretedType ( OFString value,
const signed long  pos = 0 
) const

get RTROIInterpretedType (3006,00a4)

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

◆ getSegmentedPropertyCategoryCodeSequence() [1/2]

DRTSegmentedPropertyCategoryCodeSequence & DRTRTROIObservationsSequence::Item::getSegmentedPropertyCategoryCodeSequence ( )
inline

get SegmentedPropertyCategoryCodeSequence (0062,0003)

Returns
reference to sequence element

◆ getSegmentedPropertyCategoryCodeSequence() [2/2]

const DRTSegmentedPropertyCategoryCodeSequence & DRTRTROIObservationsSequence::Item::getSegmentedPropertyCategoryCodeSequence ( ) const
inline

get SegmentedPropertyCategoryCodeSequence (0062,0003)

Returns
const reference to sequence element

◆ getTherapeuticRoleCategoryCodeSequence() [1/2]

DRTTherapeuticRoleCategoryCodeSequence & DRTRTROIObservationsSequence::Item::getTherapeuticRoleCategoryCodeSequence ( )
inline

get TherapeuticRoleCategoryCodeSequence (3010,0064)

Returns
reference to sequence element

◆ getTherapeuticRoleCategoryCodeSequence() [2/2]

const DRTTherapeuticRoleCategoryCodeSequence & DRTRTROIObservationsSequence::Item::getTherapeuticRoleCategoryCodeSequence ( ) const
inline

get TherapeuticRoleCategoryCodeSequence (3010,0064)

Returns
const reference to sequence element

◆ getTherapeuticRoleTypeCodeSequence() [1/2]

DRTTherapeuticRoleTypeCodeSequence & DRTRTROIObservationsSequence::Item::getTherapeuticRoleTypeCodeSequence ( )
inline

get TherapeuticRoleTypeCodeSequence (3010,0065)

Returns
reference to sequence element

◆ getTherapeuticRoleTypeCodeSequence() [2/2]

const DRTTherapeuticRoleTypeCodeSequence & DRTRTROIObservationsSequence::Item::getTherapeuticRoleTypeCodeSequence ( ) const
inline

get TherapeuticRoleTypeCodeSequence (3010,0065)

Returns
const reference to sequence element

◆ isEmpty()

OFBool DRTRTROIObservationsSequence::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTRTROIObservationsSequence::Item::isValid ( ) const

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

Returns
OFTrue if item is valid, OFFalse otherwise

◆ operator=()

Item & DRTRTROIObservationsSequence::Item::operator= ( const Item copy)

assignment operator

Parameters
copyitem object to be copied
Returns
reference to this object

◆ read()

OFCondition DRTRTROIObservationsSequence::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

◆ setMaterialID()

OFCondition DRTRTROIObservationsSequence::Item::setMaterialID ( const OFString value,
const OFBool  check = OFTrue 
)

set MaterialID (300a,00e1)

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

◆ setObservationNumber()

OFCondition DRTRTROIObservationsSequence::Item::setObservationNumber ( const OFString value,
const OFBool  check = OFTrue 
)

set ObservationNumber (3006,0082)

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

◆ setReferencedROINumber()

OFCondition DRTRTROIObservationsSequence::Item::setReferencedROINumber ( const OFString value,
const OFBool  check = OFTrue 
)

set ReferencedROINumber (3006,0084)

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

◆ setROIInterpreter()

OFCondition DRTRTROIObservationsSequence::Item::setROIInterpreter ( const OFString value,
const OFBool  check = OFTrue 
)

set ROIInterpreter (3006,00a6)

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

◆ setRTROIInterpretedType()

OFCondition DRTRTROIObservationsSequence::Item::setRTROIInterpretedType ( const OFString value,
const OFBool  check = OFTrue 
)

set RTROIInterpretedType (3006,00a4)

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()

OFCondition DRTRTROIObservationsSequence::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 Dec 19 2023 for DCMTK Version 3.6.8 by Doxygen 1.9.4