Interface class for ReferringPhysicianIdentificationSequence (0008,0096) More...

Inheritance diagram for DRTReferringPhysicianIdentificationSequence:

Classes
class	Item
	Item class. More...

Public Member Functions
	DRTReferringPhysicianIdentificationSequence (const OFBool emptyDefaultSequence=OFFalse)
	(default) constructor More...

	DRTReferringPhysicianIdentificationSequence (const DRTReferringPhysicianIdentificationSequence &copy)
	copy constructor More...

virtual	~DRTReferringPhysicianIdentificationSequence ()
	destructor

DRTReferringPhysicianIdentificationSequence &	operator= (const DRTReferringPhysicianIdentificationSequence &copy)
	assigment operator More...

void	clear ()
	clear all internal member variables

OFBool	isEmpty ()
	check if sequence is empty More...

OFBool	isValid () const
	check if sequence is valid, i.e. not the empty default sequence More...

size_t	getNumberOfItems () const
	get number of items in the sequence More...

OFCondition	gotoFirstItem ()
	goto first item in the sequence More...

OFCondition	gotoNextItem ()
	goto next item in the sequence More...

OFCondition	gotoItem (const size_t num)
	goto particular item in the sequence More...

OFCondition	getCurrentItem (Item *&item) const
	get current item in the sequence More...

Item &	getCurrentItem ()
	get current item in the sequence More...

const Item &	getCurrentItem () const
	get current item in the sequence More...

OFCondition	getItem (const size_t num, Item *&item)
	get particular item in the sequence More...

Item &	getItem (const size_t num)
	get particular item in the sequence More...

const Item &	getItem (const size_t num) const
	get particular item in the sequence More...

Item &	operator[] (const size_t num)
	get particular item in the sequence More...

const Item &	operator[] (const size_t num) const
	get particular item in the sequence More...

OFCondition	addItem (Item *&item)
	add new item to the end of this sequence More...

OFCondition	insertItem (const size_t pos, Item *&item)
	insert new item into the sequence More...

OFCondition	removeItem (const size_t pos)
	remove particular item from the sequence More...

OFCondition	read (DcmItem &dataset, const OFString &card, const OFString &type, const char *moduleName=NULL)
	read sequence of items from dataset More...

OFCondition	write (DcmItem &dataset, const OFString &card, const OFString &type, const char *moduleName=NULL)
	write sequence of items to dataset More...

Protected Member Functions
OFCondition	gotoItem (const size_t num, OFListIterator(Item *) &iterator)
	goto particular item in the sequence More...

OFCondition	gotoItem (const size_t num, OFListConstIterator(Item *) &iterator) const
	goto particular item in the sequence More...

Protected Member Functions inherited from DRTTypes
virtual	~DRTTypes ()
	destructor. More...

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

Additional Inherited Members
Static Protected Member Functions inherited from DRTTypes
static OFCondition	addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement element, const OFString &vm, const OFString &type, const char moduleName=NULL)
	add given element to the dataset. More...

static OFCondition	getElementFromDataset (DcmItem &dataset, DcmElement &element)
	get element from dataset More...

static OFCondition	getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0)
	get string value from element More...

static OFCondition	getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
	get string value from dataset More...

static OFCondition	putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
	put string value to dataset More...

static OFBool	checkElementValue (DcmElement &element, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL)
	check element value for correct value multiplicity and type More...

static OFCondition	getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
	get element from dataset and check it for correct value multiplicity and type. More...

static OFCondition	getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, const char *moduleName=NULL)
	get string value from dataset and check it for correct value multiplicity and type. More...

Detailed Description

Interface class for ReferringPhysicianIdentificationSequence (0008,0096)

Constructor & Destructor Documentation

◆ DRTReferringPhysicianIdentificationSequence() [1/2]

DRTReferringPhysicianIdentificationSequence::DRTReferringPhysicianIdentificationSequence ( const OFBool emptyDefaultSequence = OFFalse )

(default) constructor

Parameters

emptyDefaultSequence internal flag used to mark the empty default sequence

◆ DRTReferringPhysicianIdentificationSequence() [2/2]

DRTReferringPhysicianIdentificationSequence::DRTReferringPhysicianIdentificationSequence ( const DRTReferringPhysicianIdentificationSequence & copy )

copy constructor

Parameters

copy	sequence object to be copied

Member Function Documentation

◆ addItem()

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

◆ getCurrentItem() [1/3]

Item & DRTReferringPhysicianIdentificationSequence::getCurrentItem ( )

get current item in the sequence

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

◆ getCurrentItem() [2/3]

const Item & DRTReferringPhysicianIdentificationSequence::getCurrentItem ( ) const

get current item in the sequence

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

◆ getCurrentItem() [3/3]

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

◆ getItem() [1/3]

Item & DRTReferringPhysicianIdentificationSequence::getItem ( const size_t 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

◆ getItem() [2/3]

const Item & DRTReferringPhysicianIdentificationSequence::getItem ( const size_t 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

◆ getItem() [3/3]

OFCondition DRTReferringPhysicianIdentificationSequence::getItem	(	const size_t	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

◆ getNumberOfItems()

size_t DRTReferringPhysicianIdentificationSequence::getNumberOfItems ( ) const

get number of items in the sequence

Returns: number of items

◆ gotoFirstItem()

OFCondition DRTReferringPhysicianIdentificationSequence::gotoFirstItem ( )

goto first item in the sequence

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

◆ gotoItem() [1/3]

OFCondition DRTReferringPhysicianIdentificationSequence::gotoItem ( const size_t 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

◆ gotoItem() [2/3]

OFCondition DRTReferringPhysicianIdentificationSequence::gotoItem	(	const size_t	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

◆ gotoItem() [3/3]

OFCondition DRTReferringPhysicianIdentificationSequence::gotoItem	(	const size_t	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

◆ gotoNextItem()

OFCondition DRTReferringPhysicianIdentificationSequence::gotoNextItem ( )

goto next item in the sequence

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

◆ insertItem()

OFCondition DRTReferringPhysicianIdentificationSequence::insertItem	(	const size_t	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

◆ isEmpty()

OFBool DRTReferringPhysicianIdentificationSequence::isEmpty ( )

check if sequence is empty

Returns: OFTrue if sequence is empty, OFFalse otherwise

◆ isValid()

OFBool DRTReferringPhysicianIdentificationSequence::isValid ( ) const

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

Returns: OFTrue if sequence is valid, OFFalse otherwise

◆ operator=()

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

assigment operator

Parameters

copy	sequence object to be copied

Returns: reference to this object

◆ operator[]() [1/2]

Item & DRTReferringPhysicianIdentificationSequence::operator[] ( const size_t 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

◆ operator[]() [2/2]

const Item & DRTReferringPhysicianIdentificationSequence::operator[] ( const size_t 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

◆ read()

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

◆ removeItem()

OFCondition DRTReferringPhysicianIdentificationSequence::removeItem ( const size_t 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

◆ write()

OFCondition DRTReferringPhysicianIdentificationSequence::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/drtrpis.h

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DRTReferringPhysicianIdentificationSequence() [1/2]

◆ DRTReferringPhysicianIdentificationSequence() [2/2]

Member Function Documentation

◆ addItem()

◆ getCurrentItem() [1/3]

◆ getCurrentItem() [2/3]

◆ getCurrentItem() [3/3]

◆ getItem() [1/3]

◆ getItem() [2/3]

◆ getItem() [3/3]

◆ getNumberOfItems()

◆ gotoFirstItem()

◆ gotoItem() [1/3]

◆ gotoItem() [2/3]

◆ gotoItem() [3/3]

◆ gotoNextItem()

◆ insertItem()

◆ isEmpty()

◆ isValid()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ read()

◆ removeItem()

◆ write()