DRTROIContourSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTROIContourSequence::Item:

List of all members.

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	getROIDisplayColor (OFString &value, const signed long pos=0) const
	get ROIDisplayColor (3006,002a)
OFCondition	getROIDisplayColor (Sint32 &value, const unsigned long pos=0) const
	get ROIDisplayColor (3006,002a)
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)
DRTContourSequence &	getContourSequence ()
	get ContourSequence (3006,0040)
const DRTContourSequence &	getContourSequence () const
	get ContourSequence (3006,0040)
OFCondition	setROIDisplayColor (const OFString &value, const OFBool check=OFTrue)
	set ROIDisplayColor (3006,002a)
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
DRTContourSequence	ContourSequence
	ContourSequence (3006,0040) vr=SQ, vm=1, type=3.
DcmIntegerString	ROIDisplayColor
	ROIDisplayColor (3006,002a) vr=IS, vm=3, type=3.
DcmIntegerString	ReferencedROINumber
	ReferencedROINumber (3006,0084) vr=IS, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTROIContourSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTROIContourSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

DRTContourSequence& DRTROIContourSequence::Item::getContourSequence

(

)

[inline]

get ContourSequence (3006,0040)

Returns:

reference to sequence element

const DRTContourSequence& DRTROIContourSequence::Item::getContourSequence

(

)

const [inline]

get ContourSequence (3006,0040)

Returns:

const reference to sequence element

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

OFCondition DRTROIContourSequence::Item::getROIDisplayColor	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ROIDisplayColor (3006,002a)

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

get ROIDisplayColor (3006,002a)

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 DRTROIContourSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTROIContourSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTROIContourSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ROIDisplayColor (3006,002a)

Parameters:

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (IS) and VM (3) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTROIContourSequence::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/drtrcs.h