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
Item &	operator= (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	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	getROIObservationDescription (OFString &value, const signed long pos=0) const
	get ROIObservationDescription (3006,0088) More...
OFCondition	getROIObservationLabel (OFString &value, const signed long pos=0) const
	get ROIObservationLabel (3006,0085) 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...
DRTROIPhysicalPropertiesSequence &	getROIPhysicalPropertiesSequence ()
	get ROIPhysicalPropertiesSequence (3006,00b0) More...
const DRTROIPhysicalPropertiesSequence &	getROIPhysicalPropertiesSequence () const
	get ROIPhysicalPropertiesSequence (3006,00b0) More...
DRTRTROIIdentificationCodeSequence &	getRTROIIdentificationCodeSequence ()
	get RTROIIdentificationCodeSequence (3006,0086) More...
const DRTRTROIIdentificationCodeSequence &	getRTROIIdentificationCodeSequence () const
	get RTROIIdentificationCodeSequence (3006,0086) More...
DRTRTRelatedROISequence &	getRTRelatedROISequence ()
	get RTRelatedROISequence (3006,0030) More...
const DRTRTRelatedROISequence &	getRTRelatedROISequence () const
	get RTRelatedROISequence (3006,0030) More...
DRTRelatedRTROIObservationsSequence &	getRelatedRTROIObservationsSequence ()
	get RelatedRTROIObservationsSequence (3006,00a0) More...
const DRTRelatedRTROIObservationsSequence &	getRelatedRTROIObservationsSequence () const
	get RelatedRTROIObservationsSequence (3006,00a0) More...
DRTSegmentedPropertyCategoryCodeSequence &	getSegmentedPropertyCategoryCodeSequence ()
	get SegmentedPropertyCategoryCodeSequence (0062,0003) More...
const DRTSegmentedPropertyCategoryCodeSequence &	getSegmentedPropertyCategoryCodeSequence () const
	get SegmentedPropertyCategoryCodeSequence (0062,0003) 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	setROIObservationDescription (const OFString &value, const OFBool check=OFTrue)
	set ROIObservationDescription (3006,0088) More...
OFCondition	setROIObservationLabel (const OFString &value, const OFBool check=OFTrue)
	set ROIObservationLabel (3006,0085) 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
DcmShortString	MaterialID
	MaterialID (300a,00e1) vr=SH, vm=1, type=3.
DcmIntegerString	ObservationNumber
	ObservationNumber (3006,0082) vr=IS, vm=1, type=1.
DcmPersonName	ROIInterpreter
	ROIInterpreter (3006,00a6) vr=PN, vm=1, type=2.
DcmShortText	ROIObservationDescription
	ROIObservationDescription (3006,0088) vr=ST, vm=1, type=3.
DcmShortString	ROIObservationLabel
	ROIObservationLabel (3006,0085) vr=SH, vm=1, type=3.
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.

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

DRTRTROIObservationsSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters

emptyDefaultItem

flag used to mark the empty default item

DRTRTROIObservationsSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

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

get MaterialID (300a,00e1)

Parameters

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns

status, EC_Normal if successful, an error code otherwise

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

get ObservationNumber (3006,0082)

Parameters

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns

status, EC_Normal if successful, an error code otherwise

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

get ObservationNumber (3006,0082)

Parameters

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns

status, EC_Normal if successful, an error code otherwise

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

get ReferencedROINumber (3006,0084)

Parameters

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns

status, EC_Normal if successful, an error code otherwise

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

get ReferencedROINumber (3006,0084)

Parameters

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns

status, EC_Normal if successful, an error code otherwise

DRTRelatedRTROIObservationsSequence& DRTRTROIObservationsSequence::Item::getRelatedRTROIObservationsSequence ( )

inline

get RelatedRTROIObservationsSequence (3006,00a0)

Returns

reference to sequence element

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

inline

get RelatedRTROIObservationsSequence (3006,00a0)

Returns

const reference to sequence element

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

get ROIInterpreter (3006,00a6)

Parameters

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns

status, EC_Normal if successful, an error code otherwise

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

get ROIObservationDescription (3006,0088)

Parameters

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns

status, EC_Normal if successful, an error code otherwise

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

get ROIObservationLabel (3006,0085)

Parameters

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns

status, EC_Normal if successful, an error code otherwise

DRTROIPhysicalPropertiesSequence& DRTRTROIObservationsSequence::Item::getROIPhysicalPropertiesSequence ( )

inline

get ROIPhysicalPropertiesSequence (3006,00b0)

Returns

reference to sequence element

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

inline

get ROIPhysicalPropertiesSequence (3006,00b0)

Returns

const reference to sequence element

DRTRTRelatedROISequence& DRTRTROIObservationsSequence::Item::getRTRelatedROISequence ( )

inline

get RTRelatedROISequence (3006,0030)

Returns

reference to sequence element

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

inline

get RTRelatedROISequence (3006,0030)

Returns

const reference to sequence element

DRTRTROIIdentificationCodeSequence& DRTRTROIObservationsSequence::Item::getRTROIIdentificationCodeSequence ( )

inline

get RTROIIdentificationCodeSequence (3006,0086)

Returns

reference to sequence element

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

inline

get RTROIIdentificationCodeSequence (3006,0086)

Returns

const reference to sequence element

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

get RTROIInterpretedType (3006,00a4)

Parameters

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns

status, EC_Normal if successful, an error code otherwise

DRTSegmentedPropertyCategoryCodeSequence& DRTRTROIObservationsSequence::Item::getSegmentedPropertyCategoryCodeSequence ( )

inline

get SegmentedPropertyCategoryCodeSequence (0062,0003)

Returns

reference to sequence element

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

inline

get SegmentedPropertyCategoryCodeSequence (0062,0003)

Returns

const reference to sequence element

OFBool DRTRTROIObservationsSequence::Item::isEmpty

(

)

check if item is empty

Returns

OFTrue if item is empty, OFFalse otherwise

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

Item& DRTRTROIObservationsSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters

copy	item object to be copied

Returns

reference to this object

OFCondition DRTRTROIObservationsSequence::Item::read

(

DcmItem &

item

)

read elements from sequence item

Parameters

item	reference to DICOM sequence item from which the elements should be read

Returns

status, EC_Normal if successful, an error code otherwise

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

set MaterialID (300a,00e1)

Parameters

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (SH) and VM (1) if enabled

Returns

status, EC_Normal if successful, an error code otherwise

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

set ObservationNumber (3006,0082)

Parameters

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (IS) and VM (1) if enabled

Returns

status, EC_Normal if successful, an error code otherwise

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

set ReferencedROINumber (3006,0084)

Parameters

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (IS) and VM (1) if enabled

Returns

status, EC_Normal if successful, an error code otherwise

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

set ROIInterpreter (3006,00a6)

Parameters

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (PN) and VM (1) if enabled

Returns

status, EC_Normal if successful, an error code otherwise

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

set ROIObservationDescription (3006,0088)

Parameters

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (ST) and VM (1) if enabled

Returns

status, EC_Normal if successful, an error code otherwise

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

set ROIObservationLabel (3006,0085)

Parameters

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (SH) and VM (1) if enabled

Returns

status, EC_Normal if successful, an error code otherwise

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

set RTROIInterpretedType (3006,00a4)

Parameters

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (CS) and VM (1) if enabled

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTRTROIObservationsSequence::Item::write

(

DcmItem &

item

)

write elements to sequence item

Parameters

item	reference 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:

• dcmrt/include/dcmtk/dcmrt/seq/drtrros.h