Interface class for ReferencedDoseReferenceSequence (300c,0050) in RTBeamsModule. More...

Inheritance diagram for DRTReferencedDoseReferenceSequenceInRTBeamsModule:

Classes
class	Item
	Item class. More...
Public Member Functions
	DRTReferencedDoseReferenceSequenceInRTBeamsModule (const OFBool emptyDefaultSequence=OFFalse)
	(default) constructor
	DRTReferencedDoseReferenceSequenceInRTBeamsModule (const DRTReferencedDoseReferenceSequenceInRTBeamsModule &copy)
	copy constructor
virtual	~DRTReferencedDoseReferenceSequenceInRTBeamsModule ()
	destructor
DRTReferencedDoseReferenceSequenceInRTBeamsModule &	operator= (const DRTReferencedDoseReferenceSequenceInRTBeamsModule &copy)
	assigment operator
void	clear ()
	clear all internal member variables
OFBool	isEmpty ()
	check if sequence is empty
OFBool	isValid () const
	check if sequence is valid, i.e. not the empty default sequence
unsigned long	getNumberOfItems () const
	get number of items in the sequence
OFCondition	gotoFirstItem ()
	goto first item in the sequence
OFCondition	gotoNextItem ()
	goto next item in the sequence
OFCondition	gotoItem (const unsigned long num)
	goto particular item in the sequence
OFCondition	getCurrentItem (Item *&item) const
	get current item in the sequence
Item &	getCurrentItem ()
	get current item in the sequence
const Item &	getCurrentItem () const
	get current item in the sequence
OFCondition	getItem (const unsigned long num, Item *&item)
	get particular item in the sequence
Item &	getItem (const unsigned long num)
	get particular item in the sequence
const Item &	getItem (const unsigned long num) const
	get particular item in the sequence
Item &	operator[] (const unsigned long num)
	get particular item in the sequence
const Item &	operator[] (const unsigned long num) const
	get particular item in the sequence
OFCondition	addItem (Item *&item)
	add new item to the end of this sequence
OFCondition	insertItem (const unsigned long pos, Item *&item)
	insert new item into the sequence
OFCondition	removeItem (const unsigned long pos)
	remove particular item from the sequence
OFCondition	read (DcmItem &dataset, const OFString &card, const OFString &type, const char *moduleName=NULL)
	read sequence of items from dataset
OFCondition	write (DcmItem &dataset, const OFString &card, const OFString &type, const char *moduleName=NULL)
	write sequence of items to dataset
Protected Member Functions
OFCondition	gotoItem (const unsigned long num, OFListIterator(Item *)&iterator)
	goto particular item in the sequence
OFCondition	gotoItem (const unsigned long num, OFListConstIterator(Item *)&iterator) const
	goto particular item in the sequence
Private Member Functions
	OFListIterator (Item *) CurrentItem
	currently selected item
Private Attributes
OFBool	EmptyDefaultSequence
	internal flag used to mark the empty default sequence
OFList< Item * >	SequenceOfItems
	list of items in this sequence
Item	EmptyItem
	empty default item

Detailed Description

Interface class for ReferencedDoseReferenceSequence (300c,0050) in RTBeamsModule.

Constructor & Destructor Documentation

DRTReferencedDoseReferenceSequenceInRTBeamsModule::DRTReferencedDoseReferenceSequenceInRTBeamsModule ( const OFBool emptyDefaultSequence = OFFalse )

(default) constructor

Parameters:

emptyDefaultSequence internal flag used to mark the empty default sequence

DRTReferencedDoseReferenceSequenceInRTBeamsModule::DRTReferencedDoseReferenceSequenceInRTBeamsModule ( const DRTReferencedDoseReferenceSequenceInRTBeamsModule & copy )

copy constructor

Parameters:

copy	sequence object to be copied

Member Function Documentation

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::addItem ( Item *& item )

add new item to the end of this sequence

Parameters:

item	reference to new item pointer (result variable)

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

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::getCurrentItem ( Item *& item ) const

get current item in the sequence

Parameters:

item	reference to item pointer (result variable)

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

Item& DRTReferencedDoseReferenceSequenceInRTBeamsModule::getCurrentItem ( )

get current item in the sequence

Returns:: reference to specified item if successful, empty default item otherwise

const Item& DRTReferencedDoseReferenceSequenceInRTBeamsModule::getCurrentItem ( ) const

get current item in the sequence

Returns:: const reference to specified item if successful, empty default item otherwise

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::getItem	(	const unsigned long	num,
		Item *&	item
	)

get particular item in the sequence

Parameters:

num	number of the item to be retrieved (0..num-1)
item	reference to item pointer (result variable)

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

Item& DRTReferencedDoseReferenceSequenceInRTBeamsModule::getItem ( const unsigned long num )

get particular item in the sequence

Parameters:

num	number of the item to be retrieved (0..num-1)

Returns:: reference to specified item if successful, empty default item otherwise

const Item& DRTReferencedDoseReferenceSequenceInRTBeamsModule::getItem ( const unsigned long num ) const

get particular item in the sequence

Parameters:

num	number of the item to be retrieved (0..num-1)

Returns:: const reference to specified item if successful, empty default item otherwise

unsigned long DRTReferencedDoseReferenceSequenceInRTBeamsModule::getNumberOfItems ( ) const

get number of items in the sequence

Returns:: number of items

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::gotoFirstItem ( )

goto first item in the sequence

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

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::gotoItem ( const unsigned long num )

goto particular item in the sequence

Parameters:

num	number of the item to be selected (0..num-1)

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

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::gotoItem	(	const unsigned long	num,
		OFListIterator(Item *)&	iterator
	)		`[protected]`

goto particular item in the sequence

Parameters:

num	number of the item to be selected (0..num-1)
iterator	list iterator storing the position of the item

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

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::gotoItem	(	const unsigned long	num,
		OFListConstIterator(Item *)&	iterator
	)		const `[protected]`

goto particular item in the sequence

Parameters:

num	number of the item to be selected (0..num-1)
iterator	list iterator storing the position of the item

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

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::gotoNextItem ( )

goto next item in the sequence

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

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::insertItem	(	const unsigned long	pos,
		Item *&	item
	)

insert new item into the sequence

Parameters:

pos	position where the new item is to be inserted (0..num)
item	reference to new item pointer (result variable)

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

OFBool DRTReferencedDoseReferenceSequenceInRTBeamsModule::isEmpty ( )

check if sequence is empty

Returns:: OFTrue if sequence is empty, OFFalse otherwise

OFBool DRTReferencedDoseReferenceSequenceInRTBeamsModule::isValid ( ) const

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

Returns:: OFTrue if sequence is valid, OFFalse otherwise

DRTReferencedDoseReferenceSequenceInRTBeamsModule& DRTReferencedDoseReferenceSequenceInRTBeamsModule::operator= ( const DRTReferencedDoseReferenceSequenceInRTBeamsModule & copy )

assigment operator

Parameters:

copy	sequence object to be copied

Item& DRTReferencedDoseReferenceSequenceInRTBeamsModule::operator[] ( const unsigned long num )

get particular item in the sequence

Parameters:

num	number of the item to be retrieved (0..num-1)

Returns:: reference to specified item if successful, empty default item otherwise

const Item& DRTReferencedDoseReferenceSequenceInRTBeamsModule::operator[] ( const unsigned long num ) const

get particular item in the sequence

Parameters:

num	number of the item to be retrieved (0..num-1)

Returns:: const reference to specified item if successful, empty default item otherwise

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::read	(	DcmItem &	dataset,
		const OFString &	card,
		const OFString &	type,
		const char *	moduleName = `NULL`
	)

read sequence of items from dataset

Parameters:

dataset	reference to DICOM dataset from which the sequence should be read
card	cardinality (valid range for number of items)
type	value type (valid value: "1", "1C", "2" or something else which is not checked)
moduleName	optional module/sequence name to be printed (default: "RT object" if NULL)

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

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::removeItem ( const unsigned long pos )

remove particular item from the sequence

Parameters:

pos	position of the item to be removed (0..num-1)

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

OFCondition DRTReferencedDoseReferenceSequenceInRTBeamsModule::write	(	DcmItem &	dataset,
		const OFString &	card,
		const OFString &	type,
		const char *	moduleName = `NULL`
	)

write sequence of items to dataset

Parameters:

dataset	reference to DICOM dataset to which the sequence should be written
card	cardinality (valid range for number of items)
type	value type (valid value: "1", "2" or something else which is not checked)
moduleName	optional module/sequence name to be printed (default: "RT object" if NULL)

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/drtrdrs1.h

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation