DRTBrachyAccessoryDeviceSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTBrachyAccessoryDeviceSequence::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	getBrachyAccessoryDeviceID (OFString &value, const signed long pos=0) const
	get BrachyAccessoryDeviceID (300a,0263)
OFCondition	getBrachyAccessoryDeviceName (OFString &value, const signed long pos=0) const
	get BrachyAccessoryDeviceName (300a,0266)
OFCondition	getBrachyAccessoryDeviceNominalThickness (OFString &value, const signed long pos=0) const
	get BrachyAccessoryDeviceNominalThickness (300a,026a)
OFCondition	getBrachyAccessoryDeviceNominalThickness (Float64 &value, const unsigned long pos=0) const
	get BrachyAccessoryDeviceNominalThickness (300a,026a)
OFCondition	getBrachyAccessoryDeviceNominalTransmission (OFString &value, const signed long pos=0) const
	get BrachyAccessoryDeviceNominalTransmission (300a,026c)
OFCondition	getBrachyAccessoryDeviceNominalTransmission (Float64 &value, const unsigned long pos=0) const
	get BrachyAccessoryDeviceNominalTransmission (300a,026c)
OFCondition	getBrachyAccessoryDeviceNumber (OFString &value, const signed long pos=0) const
	get BrachyAccessoryDeviceNumber (300a,0262)
OFCondition	getBrachyAccessoryDeviceNumber (Sint32 &value, const unsigned long pos=0) const
	get BrachyAccessoryDeviceNumber (300a,0262)
OFCondition	getBrachyAccessoryDeviceType (OFString &value, const signed long pos=0) const
	get BrachyAccessoryDeviceType (300a,0264)
OFCondition	getMaterialID (OFString &value, const signed long pos=0) const
	get MaterialID (300a,00e1)
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	setBrachyAccessoryDeviceID (const OFString &value, const OFBool check=OFTrue)
	set BrachyAccessoryDeviceID (300a,0263)
OFCondition	setBrachyAccessoryDeviceName (const OFString &value, const OFBool check=OFTrue)
	set BrachyAccessoryDeviceName (300a,0266)
OFCondition	setBrachyAccessoryDeviceNominalThickness (const OFString &value, const OFBool check=OFTrue)
	set BrachyAccessoryDeviceNominalThickness (300a,026a)
OFCondition	setBrachyAccessoryDeviceNominalTransmission (const OFString &value, const OFBool check=OFTrue)
	set BrachyAccessoryDeviceNominalTransmission (300a,026c)
OFCondition	setBrachyAccessoryDeviceNumber (const OFString &value, const OFBool check=OFTrue)
	set BrachyAccessoryDeviceNumber (300a,0262)
OFCondition	setBrachyAccessoryDeviceType (const OFString &value, const OFBool check=OFTrue)
	set BrachyAccessoryDeviceType (300a,0264)
OFCondition	setMaterialID (const OFString &value, const OFBool check=OFTrue)
	set MaterialID (300a,00e1)
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
DcmShortString	BrachyAccessoryDeviceID
	BrachyAccessoryDeviceID (300a,0263) vr=SH, vm=1, type=2C.
DcmLongString	BrachyAccessoryDeviceName
	BrachyAccessoryDeviceName (300a,0266) vr=LO, vm=1, type=3.
DcmDecimalString	BrachyAccessoryDeviceNominalThickness
	BrachyAccessoryDeviceNominalThickness (300a,026a) vr=DS, vm=1, type=3.
DcmDecimalString	BrachyAccessoryDeviceNominalTransmission
	BrachyAccessoryDeviceNominalTransmission (300a,026c) vr=DS, vm=1, type=3.
DcmIntegerString	BrachyAccessoryDeviceNumber
	BrachyAccessoryDeviceNumber (300a,0262) vr=IS, vm=1, type=2C.
DcmCodeString	BrachyAccessoryDeviceType
	BrachyAccessoryDeviceType (300a,0264) vr=CS, vm=1, type=1C.
DcmShortString	MaterialID
	MaterialID (300a,00e1) vr=SH, vm=1, type=3.
DcmIntegerString	ReferencedROINumber
	ReferencedROINumber (3006,0084) vr=IS, vm=1, type=2C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTBrachyAccessoryDeviceSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTBrachyAccessoryDeviceSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTBrachyAccessoryDeviceSequence::Item::getBrachyAccessoryDeviceID	(	OFString &	value,
		const signed long	pos = 0
	)		const

get BrachyAccessoryDeviceID (300a,0263)

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

get BrachyAccessoryDeviceName (300a,0266)

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

get BrachyAccessoryDeviceNominalThickness (300a,026a)

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 DRTBrachyAccessoryDeviceSequence::Item::getBrachyAccessoryDeviceNominalThickness	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get BrachyAccessoryDeviceNominalThickness (300a,026a)

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

OFCondition DRTBrachyAccessoryDeviceSequence::Item::getBrachyAccessoryDeviceNominalTransmission	(	OFString &	value,
		const signed long	pos = 0
	)		const

get BrachyAccessoryDeviceNominalTransmission (300a,026c)

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 DRTBrachyAccessoryDeviceSequence::Item::getBrachyAccessoryDeviceNominalTransmission	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get BrachyAccessoryDeviceNominalTransmission (300a,026c)

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

OFCondition DRTBrachyAccessoryDeviceSequence::Item::getBrachyAccessoryDeviceNumber	(	OFString &	value,
		const signed long	pos = 0
	)		const

get BrachyAccessoryDeviceNumber (300a,0262)

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

get BrachyAccessoryDeviceNumber (300a,0262)

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

OFCondition DRTBrachyAccessoryDeviceSequence::Item::getBrachyAccessoryDeviceType	(	OFString &	value,
		const signed long	pos = 0
	)		const

get BrachyAccessoryDeviceType (300a,0264)

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

get MaterialID (300a,00e1)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTBrachyAccessoryDeviceSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTBrachyAccessoryDeviceSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set BrachyAccessoryDeviceID (300a,0263)

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

set BrachyAccessoryDeviceName (300a,0266)

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

set BrachyAccessoryDeviceNominalThickness (300a,026a)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTBrachyAccessoryDeviceSequence::Item::setBrachyAccessoryDeviceNominalTransmission	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set BrachyAccessoryDeviceNominalTransmission (300a,026c)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTBrachyAccessoryDeviceSequence::Item::setBrachyAccessoryDeviceNumber	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set BrachyAccessoryDeviceNumber (300a,0262)

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

set BrachyAccessoryDeviceType (300a,0264)

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

set MaterialID (300a,00e1)

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 DRTBrachyAccessoryDeviceSequence::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 DRTBrachyAccessoryDeviceSequence::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/drtbads.h