DRTReferencedControlPointSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTReferencedControlPointSequence::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	getReferencedStartControlPointIndex (OFString &value, const signed long pos=0) const
	get ReferencedStartControlPointIndex (300c,00f4)
OFCondition	getReferencedStartControlPointIndex (Sint32 &value, const unsigned long pos=0) const
	get ReferencedStartControlPointIndex (300c,00f4)
OFCondition	getReferencedStopControlPointIndex (OFString &value, const signed long pos=0) const
	get ReferencedStopControlPointIndex (300c,00f6)
OFCondition	getReferencedStopControlPointIndex (Sint32 &value, const unsigned long pos=0) const
	get ReferencedStopControlPointIndex (300c,00f6)
OFCondition	setReferencedStartControlPointIndex (const OFString &value, const OFBool check=OFTrue)
	set ReferencedStartControlPointIndex (300c,00f4)
OFCondition	setReferencedStopControlPointIndex (const OFString &value, const OFBool check=OFTrue)
	set ReferencedStopControlPointIndex (300c,00f6)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmIntegerString	ReferencedStartControlPointIndex
	ReferencedStartControlPointIndex (300c,00f4) vr=IS, vm=1, type=1.
DcmIntegerString	ReferencedStopControlPointIndex
	ReferencedStopControlPointIndex (300c,00f6) vr=IS, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTReferencedControlPointSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTReferencedControlPointSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTReferencedControlPointSequence::Item::getReferencedStartControlPointIndex	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ReferencedStartControlPointIndex (300c,00f4)

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

get ReferencedStartControlPointIndex (300c,00f4)

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

get ReferencedStopControlPointIndex (300c,00f6)

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

get ReferencedStopControlPointIndex (300c,00f6)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTReferencedControlPointSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTReferencedControlPointSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ReferencedStartControlPointIndex (300c,00f4)

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

set ReferencedStopControlPointIndex (300c,00f6)

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 DRTReferencedControlPointSequence::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/drtrcps.h