DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item Class Reference

Item class. More...

Inheritance diagram for DRTReferencedReferenceImageSequenceInRTIonBeamsModule::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	getReferenceImageNumber (OFString &value, const signed long pos=0) const
	get ReferenceImageNumber (300a,00c8)
OFCondition	getReferenceImageNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferenceImageNumber (300a,00c8)
OFCondition	getReferencedSOPClassUID (OFString &value, const signed long pos=0) const
	get ReferencedSOPClassUID (0008,1150)
OFCondition	getReferencedSOPInstanceUID (OFString &value, const signed long pos=0) const
	get ReferencedSOPInstanceUID (0008,1155)
OFCondition	setReferenceImageNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferenceImageNumber (300a,00c8)
OFCondition	setReferencedSOPClassUID (const OFString &value, const OFBool check=OFTrue)
	set ReferencedSOPClassUID (0008,1150)
OFCondition	setReferencedSOPInstanceUID (const OFString &value, const OFBool check=OFTrue)
	set ReferencedSOPInstanceUID (0008,1155)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmIntegerString	ReferenceImageNumber
	ReferenceImageNumber (300a,00c8) vr=IS, vm=1, type=1.
DcmUniqueIdentifier	ReferencedSOPClassUID
	ReferencedSOPClassUID (0008,1150) vr=UI, vm=1, type=1.
DcmUniqueIdentifier	ReferencedSOPInstanceUID
	ReferencedSOPInstanceUID (0008,1155) vr=UI, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::getReferencedSOPClassUID	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ReferencedSOPClassUID (0008,1150)

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

get ReferencedSOPInstanceUID (0008,1155)

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

get ReferenceImageNumber (300a,00c8)

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

get ReferenceImageNumber (300a,00c8)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ReferencedSOPClassUID (0008,1150)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::setReferencedSOPInstanceUID	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ReferencedSOPInstanceUID (0008,1155)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::setReferenceImageNumber	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ReferenceImageNumber (300a,00c8)

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 DRTReferencedReferenceImageSequenceInRTIonBeamsModule::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/drtrris6.h