DRTBeamLimitingDevicePositionSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTBeamLimitingDevicePositionSequence::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	getRTBeamLimitingDeviceType (OFString &value, const signed long pos=0) const
	get RTBeamLimitingDeviceType (300a,00b8)
OFCondition	setLeafJawPositions (const OFString &value, const OFBool check=OFTrue)
	set LeafJawPositions (300a,011c)
OFCondition	setRTBeamLimitingDeviceType (const OFString &value, const OFBool check=OFTrue)
	set RTBeamLimitingDeviceType (300a,00b8)
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.
DcmCodeString	RTBeamLimitingDeviceType
	RTBeamLimitingDeviceType (300a,00b8) vr=CS, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTBeamLimitingDevicePositionSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTBeamLimitingDevicePositionSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTBeamLimitingDevicePositionSequence::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 DRTBeamLimitingDevicePositionSequence::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 DRTBeamLimitingDevicePositionSequence::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 DRTBeamLimitingDevicePositionSequence::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

OFBool DRTBeamLimitingDevicePositionSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTBeamLimitingDevicePositionSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTBeamLimitingDevicePositionSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

OFCondition DRTBeamLimitingDevicePositionSequence::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 DRTBeamLimitingDevicePositionSequence::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 DRTBeamLimitingDevicePositionSequence::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 DRTBeamLimitingDevicePositionSequence::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/drtbldps.h