DRTReferencedBolusSequenceInRTBeamsModule::Item Class Reference

Item class. More...

Inheritance diagram for DRTReferencedBolusSequenceInRTBeamsModule::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	getAccessoryCode (OFString &value, const signed long pos=0) const
	get AccessoryCode (300a,00f9)
OFCondition	getBolusDescription (OFString &value, const signed long pos=0) const
	get BolusDescription (300a,00dd)
OFCondition	getBolusID (OFString &value, const signed long pos=0) const
	get BolusID (300a,00dc)
OFCondition	getReferencedROINumber (OFString &value, const signed long pos=0) const
	get ReferencedROINumber (3006,0084)
OFCondition	getReferencedROINumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedROINumber (3006,0084)
OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9)
OFCondition	setBolusDescription (const OFString &value, const OFBool check=OFTrue)
	set BolusDescription (300a,00dd)
OFCondition	setBolusID (const OFString &value, const OFBool check=OFTrue)
	set BolusID (300a,00dc)
OFCondition	setReferencedROINumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedROINumber (3006,0084)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmLongString	AccessoryCode
	AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.
DcmShortText	BolusDescription
	BolusDescription (300a,00dd) vr=ST, vm=1, type=3.
DcmShortString	BolusID
	BolusID (300a,00dc) vr=SH, vm=1, type=3.
DcmIntegerString	ReferencedROINumber
	ReferencedROINumber (3006,0084) vr=IS, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTReferencedBolusSequenceInRTBeamsModule::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTReferencedBolusSequenceInRTBeamsModule::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTReferencedBolusSequenceInRTBeamsModule::Item::getAccessoryCode	(	OFString &	value,
		const signed long	pos = 0
	)		const

get AccessoryCode (300a,00f9)

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

get BolusDescription (300a,00dd)

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

get BolusID (300a,00dc)

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

get ReferencedROINumber (3006,0084)

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

get ReferencedROINumber (3006,0084)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTReferencedBolusSequenceInRTBeamsModule::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTReferencedBolusSequenceInRTBeamsModule::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set AccessoryCode (300a,00f9)

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

set BolusDescription (300a,00dd)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTReferencedBolusSequenceInRTBeamsModule::Item::setBolusID	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set BolusID (300a,00dc)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTReferencedBolusSequenceInRTBeamsModule::Item::setReferencedROINumber	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ReferencedROINumber (3006,0084)

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 DRTReferencedBolusSequenceInRTBeamsModule::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/drtrbos1.h