Inheritance diagram for DRTRTROIObservationsSequence::Item:

Public Member Functions
	Item (const OFBool emptyDefaultItem=OFFalse)
	(default) constructor
	Item (const Item &copy)
	copy constructor
virtual	~Item ()
	destructor
Item &	operator= (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	getMaterialID (OFString &value, const signed long pos=0) const
	get MaterialID (300a,00e1)
OFCondition	getObservationNumber (OFString &value, const signed long pos=0) const
	get ObservationNumber (3006,0082)
OFCondition	getObservationNumber (Sint32 &value, const unsigned long pos=0) const
	get ObservationNumber (3006,0082)
OFCondition	getROIInterpreter (OFString &value, const signed long pos=0) const
	get ROIInterpreter (3006,00a6)
OFCondition	getROIObservationDescription (OFString &value, const signed long pos=0) const
	get ROIObservationDescription (3006,0088)
OFCondition	getROIObservationLabel (OFString &value, const signed long pos=0) const
	get ROIObservationLabel (3006,0085)
OFCondition	getRTROIInterpretedType (OFString &value, const signed long pos=0) const
	get RTROIInterpretedType (3006,00a4)
OFCondition	getReferencedROINumber (OFString &value, const signed long pos=0) const
	get ReferencedROINumber (3006,0084)
OFCondition	getReferencedROINumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedROINumber (3006,0084)
DRTROIPhysicalPropertiesSequence &	getROIPhysicalPropertiesSequence ()
	get ROIPhysicalPropertiesSequence (3006,00b0)
const DRTROIPhysicalPropertiesSequence &	getROIPhysicalPropertiesSequence () const
	get ROIPhysicalPropertiesSequence (3006,00b0)
DRTRTROIIdentificationCodeSequence &	getRTROIIdentificationCodeSequence ()
	get RTROIIdentificationCodeSequence (3006,0086)
const DRTRTROIIdentificationCodeSequence &	getRTROIIdentificationCodeSequence () const
	get RTROIIdentificationCodeSequence (3006,0086)
DRTRTRelatedROISequence &	getRTRelatedROISequence ()
	get RTRelatedROISequence (3006,0030)
const DRTRTRelatedROISequence &	getRTRelatedROISequence () const
	get RTRelatedROISequence (3006,0030)
DRTRelatedRTROIObservationsSequence &	getRelatedRTROIObservationsSequence ()
	get RelatedRTROIObservationsSequence (3006,00a0)
const DRTRelatedRTROIObservationsSequence &	getRelatedRTROIObservationsSequence () const
	get RelatedRTROIObservationsSequence (3006,00a0)
OFCondition	setMaterialID (const OFString &value, const OFBool check=OFTrue)
	set MaterialID (300a,00e1)
OFCondition	setObservationNumber (const OFString &value, const OFBool check=OFTrue)
	set ObservationNumber (3006,0082)
OFCondition	setROIInterpreter (const OFString &value, const OFBool check=OFTrue)
	set ROIInterpreter (3006,00a6)
OFCondition	setROIObservationDescription (const OFString &value, const OFBool check=OFTrue)
	set ROIObservationDescription (3006,0088)
OFCondition	setROIObservationLabel (const OFString &value, const OFBool check=OFTrue)
	set ROIObservationLabel (3006,0085)
OFCondition	setRTROIInterpretedType (const OFString &value, const OFBool check=OFTrue)
	set RTROIInterpretedType (3006,00a4)
OFCondition	setReferencedROINumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedROINumber (3006,0084)
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.

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

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation