DRTReferencedFractionGroupSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTReferencedFractionGroupSequence::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	getReferencedFractionGroupNumber (OFString &value, const signed long pos=0) const
	get ReferencedFractionGroupNumber (300c,0022)
OFCondition	getReferencedFractionGroupNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedFractionGroupNumber (300c,0022)
DRTReferencedBeamSequenceInRTDoseModule &	getReferencedBeamSequence ()
	get ReferencedBeamSequence (300c,0004)
const DRTReferencedBeamSequenceInRTDoseModule &	getReferencedBeamSequence () const
	get ReferencedBeamSequence (300c,0004)
DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule &	getReferencedBrachyApplicationSetupSequence ()
	get ReferencedBrachyApplicationSetupSequence (300c,000a)
const DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule &	getReferencedBrachyApplicationSetupSequence () const
	get ReferencedBrachyApplicationSetupSequence (300c,000a)
OFCondition	setReferencedFractionGroupNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedFractionGroupNumber (300c,0022)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DRTReferencedBeamSequenceInRTDoseModule	ReferencedBeamSequence
	ReferencedBeamSequence (300c,0004) vr=SQ, vm=1, type=1C.
DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule	ReferencedBrachyApplicationSetupSequence
	ReferencedBrachyApplicationSetupSequence (300c,000a) vr=SQ, vm=1, type=1C.
DcmIntegerString	ReferencedFractionGroupNumber
	ReferencedFractionGroupNumber (300c,0022) vr=IS, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTReferencedFractionGroupSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTReferencedFractionGroupSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

DRTReferencedBeamSequenceInRTDoseModule& DRTReferencedFractionGroupSequence::Item::getReferencedBeamSequence

(

)

[inline]

get ReferencedBeamSequence (300c,0004)

Returns:

reference to sequence element

const DRTReferencedBeamSequenceInRTDoseModule& DRTReferencedFractionGroupSequence::Item::getReferencedBeamSequence

(

)

const [inline]

get ReferencedBeamSequence (300c,0004)

Returns:

const reference to sequence element

DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule& DRTReferencedFractionGroupSequence::Item::getReferencedBrachyApplicationSetupSequence

(

)

[inline]

get ReferencedBrachyApplicationSetupSequence (300c,000a)

Returns:

reference to sequence element

const DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule& DRTReferencedFractionGroupSequence::Item::getReferencedBrachyApplicationSetupSequence

(

)

const [inline]

get ReferencedBrachyApplicationSetupSequence (300c,000a)

Returns:

const reference to sequence element

OFCondition DRTReferencedFractionGroupSequence::Item::getReferencedFractionGroupNumber	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ReferencedFractionGroupNumber (300c,0022)

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

get ReferencedFractionGroupNumber (300c,0022)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTReferencedFractionGroupSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTReferencedFractionGroupSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ReferencedFractionGroupNumber (300c,0022)

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 DRTReferencedFractionGroupSequence::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/drtrfgs.h