DRTReferencedBeamSequenceInRTDoseModule::Item Class Reference

Item class. More...

Inheritance diagram for DRTReferencedBeamSequenceInRTDoseModule::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	getReferencedBeamNumber (OFString &value, const signed long pos=0) const
	get ReferencedBeamNumber (300c,0006)
OFCondition	getReferencedBeamNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedBeamNumber (300c,0006)
OFCondition	getReferencedBrachyApplicationSetupNumber (OFString &value, const signed long pos=0) const
	get ReferencedBrachyApplicationSetupNumber (300c,000c)
OFCondition	getReferencedBrachyApplicationSetupNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedBrachyApplicationSetupNumber (300c,000c)
DRTReferencedControlPointSequence &	getReferencedControlPointSequence ()
	get ReferencedControlPointSequence (300c,00f2)
const DRTReferencedControlPointSequence &	getReferencedControlPointSequence () const
	get ReferencedControlPointSequence (300c,00f2)
OFCondition	setReferencedBeamNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedBeamNumber (300c,0006)
OFCondition	setReferencedBrachyApplicationSetupNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedBrachyApplicationSetupNumber (300c,000c)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmIntegerString	ReferencedBeamNumber
	ReferencedBeamNumber (300c,0006) vr=IS, vm=1, type=1C.
DcmIntegerString	ReferencedBrachyApplicationSetupNumber
	ReferencedBrachyApplicationSetupNumber (300c,000c) vr=IS, vm=1, type=1C.
DRTReferencedControlPointSequence	ReferencedControlPointSequence
	ReferencedControlPointSequence (300c,00f2) vr=SQ, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTReferencedBeamSequenceInRTDoseModule::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTReferencedBeamSequenceInRTDoseModule::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTReferencedBeamSequenceInRTDoseModule::Item::getReferencedBeamNumber	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ReferencedBeamNumber (300c,0006)

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

get ReferencedBeamNumber (300c,0006)

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

get ReferencedBrachyApplicationSetupNumber (300c,000c)

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

get ReferencedBrachyApplicationSetupNumber (300c,000c)

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

DRTReferencedControlPointSequence& DRTReferencedBeamSequenceInRTDoseModule::Item::getReferencedControlPointSequence

(

)

[inline]

get ReferencedControlPointSequence (300c,00f2)

Returns:

reference to sequence element

const DRTReferencedControlPointSequence& DRTReferencedBeamSequenceInRTDoseModule::Item::getReferencedControlPointSequence

(

)

const [inline]

get ReferencedControlPointSequence (300c,00f2)

Returns:

const reference to sequence element

OFBool DRTReferencedBeamSequenceInRTDoseModule::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTReferencedBeamSequenceInRTDoseModule::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTReferencedBeamSequenceInRTDoseModule::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ReferencedBeamNumber (300c,0006)

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

set ReferencedBrachyApplicationSetupNumber (300c,000c)

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 DRTReferencedBeamSequenceInRTDoseModule::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/drtrbs2.h