DRTBeamLimitingDeviceSequenceInRTImageModule::Item Class Reference

Item class. More...

Inheritance diagram for DRTBeamLimitingDeviceSequenceInRTImageModule::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	getLeafJawPositions (OFString &value, const signed long pos=0) const
	get LeafJawPositions (300a,011c)
OFCondition	getLeafJawPositions (Float64 &value, const unsigned long pos=0) const
	get LeafJawPositions (300a,011c)
OFCondition	getLeafJawPositions (OFVector< Float64 > &value) const
	get LeafJawPositions (300a,011c)
OFCondition	getLeafPositionBoundaries (OFString &value, const signed long pos=0) const
	get LeafPositionBoundaries (300a,00be)
OFCondition	getLeafPositionBoundaries (Float64 &value, const unsigned long pos=0) const
	get LeafPositionBoundaries (300a,00be)
OFCondition	getLeafPositionBoundaries (OFVector< Float64 > &value) const
	get LeafPositionBoundaries (300a,00be)
OFCondition	getNumberOfLeafJawPairs (OFString &value, const signed long pos=0) const
	get NumberOfLeafJawPairs (300a,00bc)
OFCondition	getNumberOfLeafJawPairs (Sint32 &value, const unsigned long pos=0) const
	get NumberOfLeafJawPairs (300a,00bc)
OFCondition	getRTBeamLimitingDeviceType (OFString &value, const signed long pos=0) const
	get RTBeamLimitingDeviceType (300a,00b8)
OFCondition	getSourceToBeamLimitingDeviceDistance (OFString &value, const signed long pos=0) const
	get SourceToBeamLimitingDeviceDistance (300a,00ba)
OFCondition	getSourceToBeamLimitingDeviceDistance (Float64 &value, const unsigned long pos=0) const
	get SourceToBeamLimitingDeviceDistance (300a,00ba)
OFCondition	setLeafJawPositions (const OFString &value, const OFBool check=OFTrue)
	set LeafJawPositions (300a,011c)
OFCondition	setLeafPositionBoundaries (const OFString &value, const OFBool check=OFTrue)
	set LeafPositionBoundaries (300a,00be)
OFCondition	setNumberOfLeafJawPairs (const OFString &value, const OFBool check=OFTrue)
	set NumberOfLeafJawPairs (300a,00bc)
OFCondition	setRTBeamLimitingDeviceType (const OFString &value, const OFBool check=OFTrue)
	set RTBeamLimitingDeviceType (300a,00b8)
OFCondition	setSourceToBeamLimitingDeviceDistance (const OFString &value, const OFBool check=OFTrue)
	set SourceToBeamLimitingDeviceDistance (300a,00ba)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmDecimalString	LeafJawPositions
	LeafJawPositions (300a,011c) vr=DS, vm=2-2n, type=1C.
DcmDecimalString	LeafPositionBoundaries
	LeafPositionBoundaries (300a,00be) vr=DS, vm=3-n, type=2C.
DcmIntegerString	NumberOfLeafJawPairs
	NumberOfLeafJawPairs (300a,00bc) vr=IS, vm=1, type=1C.
DcmCodeString	RTBeamLimitingDeviceType
	RTBeamLimitingDeviceType (300a,00b8) vr=CS, vm=1, type=1C.
DcmDecimalString	SourceToBeamLimitingDeviceDistance
	SourceToBeamLimitingDeviceDistance (300a,00ba) vr=DS, vm=1, type=3.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTBeamLimitingDeviceSequenceInRTImageModule::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTBeamLimitingDeviceSequenceInRTImageModule::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTBeamLimitingDeviceSequenceInRTImageModule::Item::getLeafJawPositions	(	OFString &	value,
		const signed long	pos = 0
	)		const

get LeafJawPositions (300a,011c)

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

get LeafJawPositions (300a,011c)

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 DRTBeamLimitingDeviceSequenceInRTImageModule::Item::getLeafJawPositions

(

OFVector< Float64 > &

value

)

const

get LeafJawPositions (300a,011c)

Parameters:

value

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTBeamLimitingDeviceSequenceInRTImageModule::Item::getLeafPositionBoundaries	(	OFString &	value,
		const signed long	pos = 0
	)		const

get LeafPositionBoundaries (300a,00be)

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

get LeafPositionBoundaries (300a,00be)

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 DRTBeamLimitingDeviceSequenceInRTImageModule::Item::getLeafPositionBoundaries

(

OFVector< Float64 > &

value

)

const

get LeafPositionBoundaries (300a,00be)

Parameters:

value

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTBeamLimitingDeviceSequenceInRTImageModule::Item::getNumberOfLeafJawPairs	(	OFString &	value,
		const signed long	pos = 0
	)		const

get NumberOfLeafJawPairs (300a,00bc)

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

get NumberOfLeafJawPairs (300a,00bc)

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

get RTBeamLimitingDeviceType (300a,00b8)

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

get SourceToBeamLimitingDeviceDistance (300a,00ba)

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

get SourceToBeamLimitingDeviceDistance (300a,00ba)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTBeamLimitingDeviceSequenceInRTImageModule::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTBeamLimitingDeviceSequenceInRTImageModule::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set LeafJawPositions (300a,011c)

Parameters:

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (2-2n) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTBeamLimitingDeviceSequenceInRTImageModule::Item::setLeafPositionBoundaries	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set LeafPositionBoundaries (300a,00be)

Parameters:

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (3-n) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTBeamLimitingDeviceSequenceInRTImageModule::Item::setNumberOfLeafJawPairs	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set NumberOfLeafJawPairs (300a,00bc)

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

set RTBeamLimitingDeviceType (300a,00b8)

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

set SourceToBeamLimitingDeviceDistance (300a,00ba)

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 DRTBeamLimitingDeviceSequenceInRTImageModule::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/drtblds5.h