Inheritance diagram for DRTFractionGroupSequence::Item:

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	getFractionGroupDescription (OFString &value, const signed long pos=0) const
	get FractionGroupDescription (300a,0072)
OFCondition	getFractionGroupNumber (OFString &value, const signed long pos=0) const
	get FractionGroupNumber (300a,0071)
OFCondition	getFractionGroupNumber (Sint32 &value, const unsigned long pos=0) const
	get FractionGroupNumber (300a,0071)
OFCondition	getFractionPattern (OFString &value, const signed long pos=0) const
	get FractionPattern (300a,007b)
OFCondition	getNumberOfBeams (OFString &value, const signed long pos=0) const
	get NumberOfBeams (300a,0080)
OFCondition	getNumberOfBeams (Sint32 &value, const unsigned long pos=0) const
	get NumberOfBeams (300a,0080)
OFCondition	getNumberOfBrachyApplicationSetups (OFString &value, const signed long pos=0) const
	get NumberOfBrachyApplicationSetups (300a,00a0)
OFCondition	getNumberOfBrachyApplicationSetups (Sint32 &value, const unsigned long pos=0) const
	get NumberOfBrachyApplicationSetups (300a,00a0)
OFCondition	getNumberOfFractionPatternDigitsPerDay (OFString &value, const signed long pos=0) const
	get NumberOfFractionPatternDigitsPerDay (300a,0079)
OFCondition	getNumberOfFractionPatternDigitsPerDay (Sint32 &value, const unsigned long pos=0) const
	get NumberOfFractionPatternDigitsPerDay (300a,0079)
OFCondition	getNumberOfFractionsPlanned (OFString &value, const signed long pos=0) const
	get NumberOfFractionsPlanned (300a,0078)
OFCondition	getNumberOfFractionsPlanned (Sint32 &value, const unsigned long pos=0) const
	get NumberOfFractionsPlanned (300a,0078)
OFCondition	getRepeatFractionCycleLength (OFString &value, const signed long pos=0) const
	get RepeatFractionCycleLength (300a,007a)
OFCondition	getRepeatFractionCycleLength (Sint32 &value, const unsigned long pos=0) const
	get RepeatFractionCycleLength (300a,007a)
DRTReferencedBeamSequenceInRTFractionSchemeModule &	getReferencedBeamSequence ()
	get ReferencedBeamSequence (300c,0004)
const DRTReferencedBeamSequenceInRTFractionSchemeModule &	getReferencedBeamSequence () const
	get ReferencedBeamSequence (300c,0004)
DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule &	getReferencedBrachyApplicationSetupSequence ()
	get ReferencedBrachyApplicationSetupSequence (300c,000a)
const DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule &	getReferencedBrachyApplicationSetupSequence () const
	get ReferencedBrachyApplicationSetupSequence (300c,000a)
DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule &	getReferencedDoseReferenceSequence ()
	get ReferencedDoseReferenceSequence (300c,0050)
const DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule &	getReferencedDoseReferenceSequence () const
	get ReferencedDoseReferenceSequence (300c,0050)
DRTReferencedDoseSequence &	getReferencedDoseSequence ()
	get ReferencedDoseSequence (300c,0080)
const DRTReferencedDoseSequence &	getReferencedDoseSequence () const
	get ReferencedDoseSequence (300c,0080)
OFCondition	setFractionGroupDescription (const OFString &value, const OFBool check=OFTrue)
	set FractionGroupDescription (300a,0072)
OFCondition	setFractionGroupNumber (const OFString &value, const OFBool check=OFTrue)
	set FractionGroupNumber (300a,0071)
OFCondition	setFractionPattern (const OFString &value, const OFBool check=OFTrue)
	set FractionPattern (300a,007b)
OFCondition	setNumberOfBeams (const OFString &value, const OFBool check=OFTrue)
	set NumberOfBeams (300a,0080)
OFCondition	setNumberOfBrachyApplicationSetups (const OFString &value, const OFBool check=OFTrue)
	set NumberOfBrachyApplicationSetups (300a,00a0)
OFCondition	setNumberOfFractionPatternDigitsPerDay (const OFString &value, const OFBool check=OFTrue)
	set NumberOfFractionPatternDigitsPerDay (300a,0079)
OFCondition	setNumberOfFractionsPlanned (const OFString &value, const OFBool check=OFTrue)
	set NumberOfFractionsPlanned (300a,0078)
OFCondition	setRepeatFractionCycleLength (const OFString &value, const OFBool check=OFTrue)
	set RepeatFractionCycleLength (300a,007a)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmLongString	FractionGroupDescription
	FractionGroupDescription (300a,0072) vr=LO, vm=1, type=3.
DcmIntegerString	FractionGroupNumber
	FractionGroupNumber (300a,0071) vr=IS, vm=1, type=1.
DcmLongText	FractionPattern
	FractionPattern (300a,007b) vr=LT, vm=1, type=3.
DcmIntegerString	NumberOfBeams
	NumberOfBeams (300a,0080) vr=IS, vm=1, type=1.
DcmIntegerString	NumberOfBrachyApplicationSetups
	NumberOfBrachyApplicationSetups (300a,00a0) vr=IS, vm=1, type=1.
DcmIntegerString	NumberOfFractionPatternDigitsPerDay
	NumberOfFractionPatternDigitsPerDay (300a,0079) vr=IS, vm=1, type=3.
DcmIntegerString	NumberOfFractionsPlanned
	NumberOfFractionsPlanned (300a,0078) vr=IS, vm=1, type=2.
DRTReferencedBeamSequenceInRTFractionSchemeModule	ReferencedBeamSequence
	ReferencedBeamSequence (300c,0004) vr=SQ, vm=1, type=1C.
DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule	ReferencedBrachyApplicationSetupSequence
	ReferencedBrachyApplicationSetupSequence (300c,000a) vr=SQ, vm=1, type=1C.
DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule	ReferencedDoseReferenceSequence
	ReferencedDoseReferenceSequence (300c,0050) vr=SQ, vm=1, type=3.
DRTReferencedDoseSequence	ReferencedDoseSequence
	ReferencedDoseSequence (300c,0080) vr=SQ, vm=1, type=3.
DcmIntegerString	RepeatFractionCycleLength
	RepeatFractionCycleLength (300a,007a) vr=IS, vm=1, type=3.

Detailed Description

Item class.

Constructor & Destructor Documentation

DRTFractionGroupSequence::Item::Item ( const OFBool emptyDefaultItem = OFFalse )

(default) constructor

Parameters:

emptyDefaultItem flag used to mark the empty default item

DRTFractionGroupSequence::Item::Item ( const Item & copy )

copy constructor

Parameters:

copy	item object to be copied

Member Function Documentation

OFCondition DRTFractionGroupSequence::Item::getFractionGroupDescription	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get FractionGroupDescription (300a,0072)

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

get FractionGroupNumber (300a,0071)

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

get FractionGroupNumber (300a,0071)

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

get FractionPattern (300a,007b)

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

get NumberOfBeams (300a,0080)

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

get NumberOfBeams (300a,0080)

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

get NumberOfBrachyApplicationSetups (300a,00a0)

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

get NumberOfBrachyApplicationSetups (300a,00a0)

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

get NumberOfFractionPatternDigitsPerDay (300a,0079)

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

get NumberOfFractionPatternDigitsPerDay (300a,0079)

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

get NumberOfFractionsPlanned (300a,0078)

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

get NumberOfFractionsPlanned (300a,0078)

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

DRTReferencedBeamSequenceInRTFractionSchemeModule& DRTFractionGroupSequence::Item::getReferencedBeamSequence ( ) [inline]

get ReferencedBeamSequence (300c,0004)

Returns:: reference to sequence element

const DRTReferencedBeamSequenceInRTFractionSchemeModule& DRTFractionGroupSequence::Item::getReferencedBeamSequence ( ) const [inline]

get ReferencedBeamSequence (300c,0004)

Returns:: const reference to sequence element

DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule& DRTFractionGroupSequence::Item::getReferencedBrachyApplicationSetupSequence ( ) [inline]

get ReferencedBrachyApplicationSetupSequence (300c,000a)

Returns:: reference to sequence element

const DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule& DRTFractionGroupSequence::Item::getReferencedBrachyApplicationSetupSequence ( ) const [inline]

get ReferencedBrachyApplicationSetupSequence (300c,000a)

Returns:: const reference to sequence element

DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule& DRTFractionGroupSequence::Item::getReferencedDoseReferenceSequence ( ) [inline]

get ReferencedDoseReferenceSequence (300c,0050)

Returns:: reference to sequence element

const DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule& DRTFractionGroupSequence::Item::getReferencedDoseReferenceSequence ( ) const [inline]

get ReferencedDoseReferenceSequence (300c,0050)

Returns:: const reference to sequence element

DRTReferencedDoseSequence& DRTFractionGroupSequence::Item::getReferencedDoseSequence ( ) [inline]

get ReferencedDoseSequence (300c,0080)

Returns:: reference to sequence element

const DRTReferencedDoseSequence& DRTFractionGroupSequence::Item::getReferencedDoseSequence ( ) const [inline]

get ReferencedDoseSequence (300c,0080)

Returns:: const reference to sequence element

OFCondition DRTFractionGroupSequence::Item::getRepeatFractionCycleLength	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get RepeatFractionCycleLength (300a,007a)

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

get RepeatFractionCycleLength (300a,007a)

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 DRTFractionGroupSequence::Item::isEmpty ( )

check if item is empty

Returns:: OFTrue if item is empty, OFFalse otherwise

OFBool DRTFractionGroupSequence::Item::isValid ( ) const

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

Returns:: OFTrue if item is valid, OFFalse otherwise

Item& DRTFractionGroupSequence::Item::operator= ( const Item & copy )

assigment operator

Parameters:

copy	item object to be copied

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

set FractionGroupDescription (300a,0072)

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

set FractionGroupNumber (300a,0071)

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

set FractionPattern (300a,007b)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (LT) and VM (1) if enabled

Returns:: status, EC_Normal if successful, an error code otherwise

OFCondition DRTFractionGroupSequence::Item::setNumberOfBeams	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set NumberOfBeams (300a,0080)

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

set NumberOfBrachyApplicationSetups (300a,00a0)

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

set NumberOfFractionPatternDigitsPerDay (300a,0079)

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

set NumberOfFractionsPlanned (300a,0078)

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

set RepeatFractionCycleLength (300a,007a)

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 DRTFractionGroupSequence::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/drtfgs.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation