DRTBrachyControlPointSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTBrachyControlPointSequence::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	getControlPoint3DPosition (OFString &value, const signed long pos=0) const
	get ControlPoint3DPosition (300a,02d4)
OFCondition	getControlPoint3DPosition (Float64 &value, const unsigned long pos=0) const
	get ControlPoint3DPosition (300a,02d4)
OFCondition	getControlPoint3DPosition (OFVector< Float64 > &value) const
	get ControlPoint3DPosition (300a,02d4)
OFCondition	getControlPointIndex (OFString &value, const signed long pos=0) const
	get ControlPointIndex (300a,0112)
OFCondition	getControlPointIndex (Sint32 &value, const unsigned long pos=0) const
	get ControlPointIndex (300a,0112)
OFCondition	getControlPointRelativePosition (OFString &value, const signed long pos=0) const
	get ControlPointRelativePosition (300a,02d2)
OFCondition	getControlPointRelativePosition (Float64 &value, const unsigned long pos=0) const
	get ControlPointRelativePosition (300a,02d2)
OFCondition	getCumulativeTimeWeight (OFString &value, const signed long pos=0) const
	get CumulativeTimeWeight (300a,02d6)
OFCondition	getCumulativeTimeWeight (Float64 &value, const unsigned long pos=0) const
	get CumulativeTimeWeight (300a,02d6)
DRTBrachyReferencedDoseReferenceSequence &	getBrachyReferencedDoseReferenceSequence ()
	get BrachyReferencedDoseReferenceSequence (300c,0055)
const DRTBrachyReferencedDoseReferenceSequence &	getBrachyReferencedDoseReferenceSequence () const
	get BrachyReferencedDoseReferenceSequence (300c,0055)
OFCondition	setControlPoint3DPosition (const OFString &value, const OFBool check=OFTrue)
	set ControlPoint3DPosition (300a,02d4)
OFCondition	setControlPointIndex (const OFString &value, const OFBool check=OFTrue)
	set ControlPointIndex (300a,0112)
OFCondition	setControlPointRelativePosition (const OFString &value, const OFBool check=OFTrue)
	set ControlPointRelativePosition (300a,02d2)
OFCondition	setCumulativeTimeWeight (const OFString &value, const OFBool check=OFTrue)
	set CumulativeTimeWeight (300a,02d6)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DRTBrachyReferencedDoseReferenceSequence	BrachyReferencedDoseReferenceSequence
	BrachyReferencedDoseReferenceSequence (300c,0055) vr=SQ, vm=1, type=3.
DcmDecimalString	ControlPoint3DPosition
	ControlPoint3DPosition (300a,02d4) vr=DS, vm=3, type=3.
DcmIntegerString	ControlPointIndex
	ControlPointIndex (300a,0112) vr=IS, vm=1, type=1.
DcmDecimalString	ControlPointRelativePosition
	ControlPointRelativePosition (300a,02d2) vr=DS, vm=1, type=1.
DcmDecimalString	CumulativeTimeWeight
	CumulativeTimeWeight (300a,02d6) vr=DS, vm=1, type=2.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTBrachyControlPointSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTBrachyControlPointSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

DRTBrachyReferencedDoseReferenceSequence& DRTBrachyControlPointSequence::Item::getBrachyReferencedDoseReferenceSequence

(

)

[inline]

get BrachyReferencedDoseReferenceSequence (300c,0055)

Returns:

reference to sequence element

const DRTBrachyReferencedDoseReferenceSequence& DRTBrachyControlPointSequence::Item::getBrachyReferencedDoseReferenceSequence

(

)

const [inline]

get BrachyReferencedDoseReferenceSequence (300c,0055)

Returns:

const reference to sequence element

OFCondition DRTBrachyControlPointSequence::Item::getControlPoint3DPosition	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ControlPoint3DPosition (300a,02d4)

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

get ControlPoint3DPosition (300a,02d4)

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 DRTBrachyControlPointSequence::Item::getControlPoint3DPosition

(

OFVector< Float64 > &

value

)

const

get ControlPoint3DPosition (300a,02d4)

Parameters:

value

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTBrachyControlPointSequence::Item::getControlPointIndex	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ControlPointIndex (300a,0112)

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

get ControlPointIndex (300a,0112)

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

get ControlPointRelativePosition (300a,02d2)

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

get ControlPointRelativePosition (300a,02d2)

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

get CumulativeTimeWeight (300a,02d6)

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

get CumulativeTimeWeight (300a,02d6)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTBrachyControlPointSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTBrachyControlPointSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ControlPoint3DPosition (300a,02d4)

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

set ControlPointIndex (300a,0112)

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

set ControlPointRelativePosition (300a,02d2)

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

set CumulativeTimeWeight (300a,02d6)

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 DRTBrachyControlPointSequence::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/drtbcps.h