Inheritance diagram for DRTStructureSetROISequence::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	getROIDescription (OFString &value, const signed long pos=0) const
	get ROIDescription (3006,0028)
OFCondition	getROIGenerationAlgorithm (OFString &value, const signed long pos=0) const
	get ROIGenerationAlgorithm (3006,0036)
OFCondition	getROIGenerationDescription (OFString &value, const signed long pos=0) const
	get ROIGenerationDescription (3006,0038)
OFCondition	getROIName (OFString &value, const signed long pos=0) const
	get ROIName (3006,0026)
OFCondition	getROINumber (OFString &value, const signed long pos=0) const
	get ROINumber (3006,0022)
OFCondition	getROINumber (Sint32 &value, const unsigned long pos=0) const
	get ROINumber (3006,0022)
OFCondition	getROIVolume (OFString &value, const signed long pos=0) const
	get ROIVolume (3006,002c)
OFCondition	getROIVolume (Float64 &value, const unsigned long pos=0) const
	get ROIVolume (3006,002c)
OFCondition	getReferencedFrameOfReferenceUID (OFString &value, const signed long pos=0) const
	get ReferencedFrameOfReferenceUID (3006,0024)
OFCondition	setROIDescription (const OFString &value, const OFBool check=OFTrue)
	set ROIDescription (3006,0028)
OFCondition	setROIGenerationAlgorithm (const OFString &value, const OFBool check=OFTrue)
	set ROIGenerationAlgorithm (3006,0036)
OFCondition	setROIGenerationDescription (const OFString &value, const OFBool check=OFTrue)
	set ROIGenerationDescription (3006,0038)
OFCondition	setROIName (const OFString &value, const OFBool check=OFTrue)
	set ROIName (3006,0026)
OFCondition	setROINumber (const OFString &value, const OFBool check=OFTrue)
	set ROINumber (3006,0022)
OFCondition	setROIVolume (const OFString &value, const OFBool check=OFTrue)
	set ROIVolume (3006,002c)
OFCondition	setReferencedFrameOfReferenceUID (const OFString &value, const OFBool check=OFTrue)
	set ReferencedFrameOfReferenceUID (3006,0024)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmShortText	ROIDescription
	ROIDescription (3006,0028) vr=ST, vm=1, type=3.
DcmCodeString	ROIGenerationAlgorithm
	ROIGenerationAlgorithm (3006,0036) vr=CS, vm=1, type=2C.
DcmLongString	ROIGenerationDescription
	ROIGenerationDescription (3006,0038) vr=LO, vm=1, type=3.
DcmLongString	ROIName
	ROIName (3006,0026) vr=LO, vm=1, type=2C.
DcmIntegerString	ROINumber
	ROINumber (3006,0022) vr=IS, vm=1, type=1C.
DcmDecimalString	ROIVolume
	ROIVolume (3006,002c) vr=DS, vm=1, type=3.
DcmUniqueIdentifier	ReferencedFrameOfReferenceUID
	ReferencedFrameOfReferenceUID (3006,0024) vr=UI, vm=1, type=1C.

Detailed Description

Item class.

Constructor & Destructor Documentation

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

(default) constructor

Parameters:

emptyDefaultItem flag used to mark the empty default item

DRTStructureSetROISequence::Item::Item ( const Item & copy )

copy constructor

Parameters:

copy	item object to be copied

Member Function Documentation

OFCondition DRTStructureSetROISequence::Item::getReferencedFrameOfReferenceUID	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ReferencedFrameOfReferenceUID (3006,0024)

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 DRTStructureSetROISequence::Item::getROIDescription	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ROIDescription (3006,0028)

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 DRTStructureSetROISequence::Item::getROIGenerationAlgorithm	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ROIGenerationAlgorithm (3006,0036)

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 DRTStructureSetROISequence::Item::getROIGenerationDescription	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ROIGenerationDescription (3006,0038)

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 DRTStructureSetROISequence::Item::getROIName	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ROIName (3006,0026)

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 DRTStructureSetROISequence::Item::getROINumber	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ROINumber (3006,0022)

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 DRTStructureSetROISequence::Item::getROINumber	(	Sint32 &	value,
		const unsigned long	pos = `0`
	)		const

get ROINumber (3006,0022)

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 DRTStructureSetROISequence::Item::getROIVolume	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ROIVolume (3006,002c)

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 DRTStructureSetROISequence::Item::getROIVolume	(	Float64 &	value,
		const unsigned long	pos = `0`
	)		const

get ROIVolume (3006,002c)

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

OFBool DRTStructureSetROISequence::Item::isEmpty ( )

check if item is empty

Returns:: OFTrue if item is empty, OFFalse otherwise

OFBool DRTStructureSetROISequence::Item::isValid ( ) const

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

Returns:: OFTrue if item is valid, OFFalse otherwise

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

assigment operator

Parameters:

copy	item object to be copied

OFCondition DRTStructureSetROISequence::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 DRTStructureSetROISequence::Item::setReferencedFrameOfReferenceUID	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ReferencedFrameOfReferenceUID (3006,0024)

Parameters:

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

Returns:: status, EC_Normal if successful, an error code otherwise

OFCondition DRTStructureSetROISequence::Item::setROIDescription	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ROIDescription (3006,0028)

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 DRTStructureSetROISequence::Item::setROIGenerationAlgorithm	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ROIGenerationAlgorithm (3006,0036)

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 DRTStructureSetROISequence::Item::setROIGenerationDescription	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ROIGenerationDescription (3006,0038)

Parameters:

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

Returns:: status, EC_Normal if successful, an error code otherwise

OFCondition DRTStructureSetROISequence::Item::setROIName	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ROIName (3006,0026)

Parameters:

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

Returns:: status, EC_Normal if successful, an error code otherwise

OFCondition DRTStructureSetROISequence::Item::setROINumber	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ROINumber (3006,0022)

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 DRTStructureSetROISequence::Item::setROIVolume	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ROIVolume (3006,002c)

Parameters:

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

Returns:: status, EC_Normal if successful, an error code otherwise

OFCondition DRTStructureSetROISequence::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/drtssrs.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation