DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item Class Reference

Item class. More...

Inheritance diagram for DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::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	getRangeModulatorGatingStartValue (Float32 &value, const unsigned long pos=0) const
	get RangeModulatorGatingStartValue (300a,0382)
OFCondition	getRangeModulatorGatingStopValue (Float32 &value, const unsigned long pos=0) const
	get RangeModulatorGatingStopValue (300a,0384)
OFCondition	getReferencedRangeModulatorNumber (OFString &value, const signed long pos=0) const
	get ReferencedRangeModulatorNumber (300c,0104)
OFCondition	getReferencedRangeModulatorNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedRangeModulatorNumber (300c,0104)
OFCondition	setRangeModulatorGatingStartValue (const Float32 value, const unsigned long pos=0)
	set RangeModulatorGatingStartValue (300a,0382)
OFCondition	setRangeModulatorGatingStopValue (const Float32 value, const unsigned long pos=0)
	set RangeModulatorGatingStopValue (300a,0384)
OFCondition	setReferencedRangeModulatorNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedRangeModulatorNumber (300c,0104)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmFloatingPointSingle	RangeModulatorGatingStartValue
	RangeModulatorGatingStartValue (300a,0382) vr=FL, vm=1, type=1C.
DcmFloatingPointSingle	RangeModulatorGatingStopValue
	RangeModulatorGatingStopValue (300a,0384) vr=FL, vm=1, type=1C.
DcmIntegerString	ReferencedRangeModulatorNumber
	ReferencedRangeModulatorNumber (300c,0104) vr=IS, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item::getRangeModulatorGatingStartValue	(	Float32 &	value,
		const unsigned long	pos = 0
	)		const

get RangeModulatorGatingStartValue (300a,0382)

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 DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item::getRangeModulatorGatingStopValue	(	Float32 &	value,
		const unsigned long	pos = 0
	)		const

get RangeModulatorGatingStopValue (300a,0384)

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

get ReferencedRangeModulatorNumber (300c,0104)

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

get ReferencedRangeModulatorNumber (300c,0104)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

OFCondition DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::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 DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item::setRangeModulatorGatingStartValue	(	const Float32	value,
		const unsigned long	pos = 0
	)

set RangeModulatorGatingStartValue (300a,0382)

Parameters:

value	value to be set (should be valid for this VR)
pos	index of the value to be set (0..vm-1), vm=1

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item::setRangeModulatorGatingStopValue	(	const Float32	value,
		const unsigned long	pos = 0
	)

set RangeModulatorGatingStopValue (300a,0384)

Parameters:

value	value to be set (should be valid for this VR)
pos	index of the value to be set (0..vm-1), vm=1

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item::setReferencedRangeModulatorNumber	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ReferencedRangeModulatorNumber (300c,0104)

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 DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::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/drtrmss7.h