DRTMeasuredDoseReferenceSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTMeasuredDoseReferenceSequence::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	getDoseUnits (OFString &value, const signed long pos=0) const
	get DoseUnits (3004,0002)
OFCondition	getMeasuredDoseDescription (OFString &value, const signed long pos=0) const
	get MeasuredDoseDescription (3008,0012)
OFCondition	getMeasuredDoseReferenceNumber (OFString &value, const signed long pos=0) const
	get MeasuredDoseReferenceNumber (3008,0064)
OFCondition	getMeasuredDoseReferenceNumber (Sint32 &value, const unsigned long pos=0) const
	get MeasuredDoseReferenceNumber (3008,0064)
OFCondition	getMeasuredDoseType (OFString &value, const signed long pos=0) const
	get MeasuredDoseType (3008,0014)
OFCondition	getMeasuredDoseValue (OFString &value, const signed long pos=0) const
	get MeasuredDoseValue (3008,0016)
OFCondition	getMeasuredDoseValue (Float64 &value, const unsigned long pos=0) const
	get MeasuredDoseValue (3008,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	setDoseUnits (const OFString &value, const OFBool check=OFTrue)
	set DoseUnits (3004,0002)
OFCondition	setMeasuredDoseDescription (const OFString &value, const OFBool check=OFTrue)
	set MeasuredDoseDescription (3008,0012)
OFCondition	setMeasuredDoseReferenceNumber (const OFString &value, const OFBool check=OFTrue)
	set MeasuredDoseReferenceNumber (3008,0064)
OFCondition	setMeasuredDoseType (const OFString &value, const OFBool check=OFTrue)
	set MeasuredDoseType (3008,0014)
OFCondition	setMeasuredDoseValue (const OFString &value, const OFBool check=OFTrue)
	set MeasuredDoseValue (3008,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
DcmCodeString	DoseUnits
	DoseUnits (3004,0002) vr=CS, vm=1, type=1.
DcmShortText	MeasuredDoseDescription
	MeasuredDoseDescription (3008,0012) vr=ST, vm=1, type=3.
DcmIntegerString	MeasuredDoseReferenceNumber
	MeasuredDoseReferenceNumber (3008,0064) vr=IS, vm=1, type=1C.
DcmCodeString	MeasuredDoseType
	MeasuredDoseType (3008,0014) vr=CS, vm=1, type=2.
DcmDecimalString	MeasuredDoseValue
	MeasuredDoseValue (3008,0016) vr=DS, vm=1, type=2.
DcmIntegerString	ReferencedDoseReferenceNumber
	ReferencedDoseReferenceNumber (300c,0051) vr=IS, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTMeasuredDoseReferenceSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTMeasuredDoseReferenceSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTMeasuredDoseReferenceSequence::Item::getDoseUnits	(	OFString &	value,
		const signed long	pos = 0
	)		const

get DoseUnits (3004,0002)

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

get MeasuredDoseDescription (3008,0012)

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

get MeasuredDoseReferenceNumber (3008,0064)

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

get MeasuredDoseReferenceNumber (3008,0064)

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

get MeasuredDoseType (3008,0014)

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

get MeasuredDoseValue (3008,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 DRTMeasuredDoseReferenceSequence::Item::getMeasuredDoseValue	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get MeasuredDoseValue (3008,0016)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTMeasuredDoseReferenceSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTMeasuredDoseReferenceSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set DoseUnits (3004,0002)

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

set MeasuredDoseDescription (3008,0012)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (ST) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTMeasuredDoseReferenceSequence::Item::setMeasuredDoseReferenceNumber	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set MeasuredDoseReferenceNumber (3008,0064)

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

set MeasuredDoseType (3008,0014)

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

set MeasuredDoseValue (3008,0016)

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 DRTMeasuredDoseReferenceSequence::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 DRTMeasuredDoseReferenceSequence::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/drtmdrs.h