DRTTreatmentSummaryMeasuredDoseReferenceSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTTreatmentSummaryMeasuredDoseReferenceSequence::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	getCumulativeDoseToDoseReference (OFString &value, const signed long pos=0) const
	get CumulativeDoseToDoseReference (3008,0052)
OFCondition	getCumulativeDoseToDoseReference (Float64 &value, const unsigned long pos=0) const
	get CumulativeDoseToDoseReference (3008,0052)
OFCondition	getDoseReferenceDescription (OFString &value, const signed long pos=0) const
	get DoseReferenceDescription (300a,0016)
OFCondition	getReferencedDoseReferenceNumber (OFString &value, const signed long pos=0) const
	get ReferencedDoseReferenceNumber (300c,0051)
OFCondition	getReferencedDoseReferenceNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedDoseReferenceNumber (300c,0051)
OFCondition	setCumulativeDoseToDoseReference (const OFString &value, const OFBool check=OFTrue)
	set CumulativeDoseToDoseReference (3008,0052)
OFCondition	setDoseReferenceDescription (const OFString &value, const OFBool check=OFTrue)
	set DoseReferenceDescription (300a,0016)
OFCondition	setReferencedDoseReferenceNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedDoseReferenceNumber (300c,0051)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmDecimalString	CumulativeDoseToDoseReference
	CumulativeDoseToDoseReference (3008,0052) vr=DS, vm=1, type=1C.
DcmLongString	DoseReferenceDescription
	DoseReferenceDescription (300a,0016) vr=LO, vm=1, type=3.
DcmIntegerString	ReferencedDoseReferenceNumber
	ReferencedDoseReferenceNumber (300c,0051) vr=IS, vm=1, type=3.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTTreatmentSummaryMeasuredDoseReferenceSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTTreatmentSummaryMeasuredDoseReferenceSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTTreatmentSummaryMeasuredDoseReferenceSequence::Item::getCumulativeDoseToDoseReference	(	OFString &	value,
		const signed long	pos = 0
	)		const

get CumulativeDoseToDoseReference (3008,0052)

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

get CumulativeDoseToDoseReference (3008,0052)

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

get DoseReferenceDescription (300a,0016)

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

get ReferencedDoseReferenceNumber (300c,0051)

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

get ReferencedDoseReferenceNumber (300c,0051)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTTreatmentSummaryMeasuredDoseReferenceSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTTreatmentSummaryMeasuredDoseReferenceSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set CumulativeDoseToDoseReference (3008,0052)

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

set DoseReferenceDescription (300a,0016)

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

set ReferencedDoseReferenceNumber (300c,0051)

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 DRTTreatmentSummaryMeasuredDoseReferenceSequence::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/drttsmds.h