Inheritance diagram for DRTContourSequence::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	getAttachedContours (OFString &value, const signed long pos=0) const
	get AttachedContours (3006,0049)
OFCondition	getAttachedContours (Sint32 &value, const unsigned long pos=0) const
	get AttachedContours (3006,0049)
OFCondition	getContourData (OFString &value, const signed long pos=0) const
	get ContourData (3006,0050)
OFCondition	getContourData (Float64 &value, const unsigned long pos=0) const
	get ContourData (3006,0050)
OFCondition	getContourData (OFVector< Float64 > &value) const
	get ContourData (3006,0050)
OFCondition	getContourGeometricType (OFString &value, const signed long pos=0) const
	get ContourGeometricType (3006,0042)
OFCondition	getContourNumber (OFString &value, const signed long pos=0) const
	get ContourNumber (3006,0048)
OFCondition	getContourNumber (Sint32 &value, const unsigned long pos=0) const
	get ContourNumber (3006,0048)
OFCondition	getContourOffsetVector (OFString &value, const signed long pos=0) const
	get ContourOffsetVector (3006,0045)
OFCondition	getContourOffsetVector (Float64 &value, const unsigned long pos=0) const
	get ContourOffsetVector (3006,0045)
OFCondition	getContourOffsetVector (OFVector< Float64 > &value) const
	get ContourOffsetVector (3006,0045)
OFCondition	getContourSlabThickness (OFString &value, const signed long pos=0) const
	get ContourSlabThickness (3006,0044)
OFCondition	getContourSlabThickness (Float64 &value, const unsigned long pos=0) const
	get ContourSlabThickness (3006,0044)
OFCondition	getNumberOfContourPoints (OFString &value, const signed long pos=0) const
	get NumberOfContourPoints (3006,0046)
OFCondition	getNumberOfContourPoints (Sint32 &value, const unsigned long pos=0) const
	get NumberOfContourPoints (3006,0046)
DRTContourImageSequence &	getContourImageSequence ()
	get ContourImageSequence (3006,0016)
const DRTContourImageSequence &	getContourImageSequence () const
	get ContourImageSequence (3006,0016)
OFCondition	setAttachedContours (const OFString &value, const OFBool check=OFTrue)
	set AttachedContours (3006,0049)
OFCondition	setContourData (const OFString &value, const OFBool check=OFTrue)
	set ContourData (3006,0050)
OFCondition	setContourGeometricType (const OFString &value, const OFBool check=OFTrue)
	set ContourGeometricType (3006,0042)
OFCondition	setContourNumber (const OFString &value, const OFBool check=OFTrue)
	set ContourNumber (3006,0048)
OFCondition	setContourOffsetVector (const OFString &value, const OFBool check=OFTrue)
	set ContourOffsetVector (3006,0045)
OFCondition	setContourSlabThickness (const OFString &value, const OFBool check=OFTrue)
	set ContourSlabThickness (3006,0044)
OFCondition	setNumberOfContourPoints (const OFString &value, const OFBool check=OFTrue)
	set NumberOfContourPoints (3006,0046)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmIntegerString	AttachedContours
	AttachedContours (3006,0049) vr=IS, vm=1-n, type=3.
DcmDecimalString	ContourData
	ContourData (3006,0050) vr=DS, vm=3-3n, type=1C.
DcmCodeString	ContourGeometricType
	ContourGeometricType (3006,0042) vr=CS, vm=1, type=1C.
DRTContourImageSequence	ContourImageSequence
	ContourImageSequence (3006,0016) vr=SQ, vm=1, type=3.
DcmIntegerString	ContourNumber
	ContourNumber (3006,0048) vr=IS, vm=1, type=3.
DcmDecimalString	ContourOffsetVector
	ContourOffsetVector (3006,0045) vr=DS, vm=3, type=3.
DcmDecimalString	ContourSlabThickness
	ContourSlabThickness (3006,0044) vr=DS, vm=1, type=3.
DcmIntegerString	NumberOfContourPoints
	NumberOfContourPoints (3006,0046) vr=IS, vm=1, type=1C.

Detailed Description

Item class.

Constructor & Destructor Documentation

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

(default) constructor

Parameters:

emptyDefaultItem flag used to mark the empty default item

DRTContourSequence::Item::Item ( const Item & copy )

copy constructor

Parameters:

copy	item object to be copied

Member Function Documentation

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

get AttachedContours (3006,0049)

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

get AttachedContours (3006,0049)

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

get ContourData (3006,0050)

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

get ContourData (3006,0050)

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 DRTContourSequence::Item::getContourData ( OFVector< Float64 > & value ) const

get ContourData (3006,0050)

Parameters:

value reference to variable in which the value(s) should be stored

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

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

get ContourGeometricType (3006,0042)

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

DRTContourImageSequence& DRTContourSequence::Item::getContourImageSequence ( ) [inline]

get ContourImageSequence (3006,0016)

Returns:: reference to sequence element

const DRTContourImageSequence& DRTContourSequence::Item::getContourImageSequence ( ) const [inline]

get ContourImageSequence (3006,0016)

Returns:: const reference to sequence element

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

get ContourNumber (3006,0048)

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

get ContourNumber (3006,0048)

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

get ContourOffsetVector (3006,0045)

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

get ContourOffsetVector (3006,0045)

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 DRTContourSequence::Item::getContourOffsetVector ( OFVector< Float64 > & value ) const

get ContourOffsetVector (3006,0045)

Parameters:

value reference to variable in which the value(s) should be stored

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

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

get ContourSlabThickness (3006,0044)

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

get ContourSlabThickness (3006,0044)

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

get NumberOfContourPoints (3006,0046)

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

get NumberOfContourPoints (3006,0046)

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 DRTContourSequence::Item::isEmpty ( )

check if item is empty

Returns:: OFTrue if item is empty, OFFalse otherwise

OFBool DRTContourSequence::Item::isValid ( ) const

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

Returns:: OFTrue if item is valid, OFFalse otherwise

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

assigment operator

Parameters:

copy	item object to be copied

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

set AttachedContours (3006,0049)

Parameters:

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

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

OFCondition DRTContourSequence::Item::setContourData	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ContourData (3006,0050)

Parameters:

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

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

OFCondition DRTContourSequence::Item::setContourGeometricType	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ContourGeometricType (3006,0042)

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

set ContourNumber (3006,0048)

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

set ContourOffsetVector (3006,0045)

Parameters:

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

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

OFCondition DRTContourSequence::Item::setContourSlabThickness	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ContourSlabThickness (3006,0044)

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

set NumberOfContourPoints (3006,0046)

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 DRTContourSequence::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/drtcs.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation