DRTShieldingDeviceSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTShieldingDeviceSequence::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	getShieldingDeviceDescription (OFString &value, const signed long pos=0) const
	get ShieldingDeviceDescription (300a,01a6)
OFCondition	getShieldingDeviceLabel (OFString &value, const signed long pos=0) const
	get ShieldingDeviceLabel (300a,01a4)
OFCondition	getShieldingDevicePosition (OFString &value, const signed long pos=0) const
	get ShieldingDevicePosition (300a,01a8)
OFCondition	getShieldingDeviceType (OFString &value, const signed long pos=0) const
	get ShieldingDeviceType (300a,01a2)
OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9)
OFCondition	setShieldingDeviceDescription (const OFString &value, const OFBool check=OFTrue)
	set ShieldingDeviceDescription (300a,01a6)
OFCondition	setShieldingDeviceLabel (const OFString &value, const OFBool check=OFTrue)
	set ShieldingDeviceLabel (300a,01a4)
OFCondition	setShieldingDevicePosition (const OFString &value, const OFBool check=OFTrue)
	set ShieldingDevicePosition (300a,01a8)
OFCondition	setShieldingDeviceType (const OFString &value, const OFBool check=OFTrue)
	set ShieldingDeviceType (300a,01a2)
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	ShieldingDeviceDescription
	ShieldingDeviceDescription (300a,01a6) vr=ST, vm=1, type=3.
DcmShortString	ShieldingDeviceLabel
	ShieldingDeviceLabel (300a,01a4) vr=SH, vm=1, type=2C.
DcmShortString	ShieldingDevicePosition
	ShieldingDevicePosition (300a,01a8) vr=SH, vm=1, type=3.
DcmCodeString	ShieldingDeviceType
	ShieldingDeviceType (300a,01a2) vr=CS, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTShieldingDeviceSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTShieldingDeviceSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

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

get ShieldingDeviceDescription (300a,01a6)

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

get ShieldingDeviceLabel (300a,01a4)

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

get ShieldingDevicePosition (300a,01a8)

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

get ShieldingDeviceType (300a,01a2)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTShieldingDeviceSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTShieldingDeviceSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ShieldingDeviceDescription (300a,01a6)

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

set ShieldingDeviceLabel (300a,01a4)

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

set ShieldingDevicePosition (300a,01a8)

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

set ShieldingDeviceType (300a,01a2)

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 DRTShieldingDeviceSequence::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/drtshds.h