DRTRangeShifterSettingsSequenceInRTIonBeamsModule::Item Class Reference

Item class. More...

Inheritance diagram for DRTRangeShifterSettingsSequenceInRTIonBeamsModule::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	getIsocenterToRangeShifterDistance (Float32 &value, const unsigned long pos=0) const
	get IsocenterToRangeShifterDistance (300a,0364)
OFCondition	getRangeShifterSetting (OFString &value, const signed long pos=0) const
	get RangeShifterSetting (300a,0362)
OFCondition	getRangeShifterWaterEquivalentThickness (Float32 &value, const unsigned long pos=0) const
	get RangeShifterWaterEquivalentThickness (300a,0366)
OFCondition	getReferencedRangeShifterNumber (OFString &value, const signed long pos=0) const
	get ReferencedRangeShifterNumber (300c,0100)
OFCondition	getReferencedRangeShifterNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedRangeShifterNumber (300c,0100)
OFCondition	setIsocenterToRangeShifterDistance (const Float32 value, const unsigned long pos=0)
	set IsocenterToRangeShifterDistance (300a,0364)
OFCondition	setRangeShifterSetting (const OFString &value, const OFBool check=OFTrue)
	set RangeShifterSetting (300a,0362)
OFCondition	setRangeShifterWaterEquivalentThickness (const Float32 value, const unsigned long pos=0)
	set RangeShifterWaterEquivalentThickness (300a,0366)
OFCondition	setReferencedRangeShifterNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedRangeShifterNumber (300c,0100)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmFloatingPointSingle	IsocenterToRangeShifterDistance
	IsocenterToRangeShifterDistance (300a,0364) vr=FL, vm=1, type=3.
DcmLongString	RangeShifterSetting
	RangeShifterSetting (300a,0362) vr=LO, vm=1, type=1.
DcmFloatingPointSingle	RangeShifterWaterEquivalentThickness
	RangeShifterWaterEquivalentThickness (300a,0366) vr=FL, vm=1, type=3.
DcmIntegerString	ReferencedRangeShifterNumber
	ReferencedRangeShifterNumber (300c,0100) vr=IS, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTRangeShifterSettingsSequenceInRTIonBeamsModule::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTRangeShifterSettingsSequenceInRTIonBeamsModule::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTRangeShifterSettingsSequenceInRTIonBeamsModule::Item::getIsocenterToRangeShifterDistance	(	Float32 &	value,
		const unsigned long	pos = 0
	)		const

get IsocenterToRangeShifterDistance (300a,0364)

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

get RangeShifterSetting (300a,0362)

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

get RangeShifterWaterEquivalentThickness (300a,0366)

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

get ReferencedRangeShifterNumber (300c,0100)

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

get ReferencedRangeShifterNumber (300c,0100)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTRangeShifterSettingsSequenceInRTIonBeamsModule::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTRangeShifterSettingsSequenceInRTIonBeamsModule::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set IsocenterToRangeShifterDistance (300a,0364)

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

set RangeShifterSetting (300a,0362)

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

set RangeShifterWaterEquivalentThickness (300a,0366)

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

set ReferencedRangeShifterNumber (300c,0100)

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 DRTRangeShifterSettingsSequenceInRTIonBeamsModule::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/drtrshs6.h