DRTApplicatorSequenceInRTIonBeamsSessionRecordModule::Item Class Reference

Item class. More...

Inheritance diagram for DRTApplicatorSequenceInRTIonBeamsSessionRecordModule::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	getApplicatorDescription (OFString &value, const signed long pos=0) const
	get ApplicatorDescription (300a,010a)
OFCondition	getApplicatorID (OFString &value, const signed long pos=0) const
	get ApplicatorID (300a,0108)
OFCondition	getApplicatorType (OFString &value, const signed long pos=0) const
	get ApplicatorType (300a,0109)
OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9)
OFCondition	setApplicatorDescription (const OFString &value, const OFBool check=OFTrue)
	set ApplicatorDescription (300a,010a)
OFCondition	setApplicatorID (const OFString &value, const OFBool check=OFTrue)
	set ApplicatorID (300a,0108)
OFCondition	setApplicatorType (const OFString &value, const OFBool check=OFTrue)
	set ApplicatorType (300a,0109)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmLongString	AccessoryCode
	AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.
DcmLongString	ApplicatorDescription
	ApplicatorDescription (300a,010a) vr=LO, vm=1, type=3.
DcmShortString	ApplicatorID
	ApplicatorID (300a,0108) vr=SH, vm=1, type=1.
DcmCodeString	ApplicatorType
	ApplicatorType (300a,0109) vr=CS, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTApplicatorSequenceInRTIonBeamsSessionRecordModule::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTApplicatorSequenceInRTIonBeamsSessionRecordModule::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

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

get ApplicatorDescription (300a,010a)

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

get ApplicatorID (300a,0108)

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

get ApplicatorType (300a,0109)

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

OFBool DRTApplicatorSequenceInRTIonBeamsSessionRecordModule::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTApplicatorSequenceInRTIonBeamsSessionRecordModule::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTApplicatorSequenceInRTIonBeamsSessionRecordModule::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ApplicatorDescription (300a,010a)

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

set ApplicatorID (300a,0108)

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

set ApplicatorType (300a,0109)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTApplicatorSequenceInRTIonBeamsSessionRecordModule::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/drtas7.h