DRTChannelShieldSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTChannelShieldSequence::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	getChannelShieldID (OFString &value, const signed long pos=0) const
	get ChannelShieldID (300a,02b3)
OFCondition	getChannelShieldName (OFString &value, const signed long pos=0) const
	get ChannelShieldName (300a,02b4)
OFCondition	getChannelShieldNominalThickness (OFString &value, const signed long pos=0) const
	get ChannelShieldNominalThickness (300a,02b8)
OFCondition	getChannelShieldNominalThickness (Float64 &value, const unsigned long pos=0) const
	get ChannelShieldNominalThickness (300a,02b8)
OFCondition	getChannelShieldNominalTransmission (OFString &value, const signed long pos=0) const
	get ChannelShieldNominalTransmission (300a,02ba)
OFCondition	getChannelShieldNominalTransmission (Float64 &value, const unsigned long pos=0) const
	get ChannelShieldNominalTransmission (300a,02ba)
OFCondition	getChannelShieldNumber (OFString &value, const signed long pos=0) const
	get ChannelShieldNumber (300a,02b2)
OFCondition	getChannelShieldNumber (Sint32 &value, const unsigned long pos=0) const
	get ChannelShieldNumber (300a,02b2)
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	setChannelShieldID (const OFString &value, const OFBool check=OFTrue)
	set ChannelShieldID (300a,02b3)
OFCondition	setChannelShieldName (const OFString &value, const OFBool check=OFTrue)
	set ChannelShieldName (300a,02b4)
OFCondition	setChannelShieldNominalThickness (const OFString &value, const OFBool check=OFTrue)
	set ChannelShieldNominalThickness (300a,02b8)
OFCondition	setChannelShieldNominalTransmission (const OFString &value, const OFBool check=OFTrue)
	set ChannelShieldNominalTransmission (300a,02ba)
OFCondition	setChannelShieldNumber (const OFString &value, const OFBool check=OFTrue)
	set ChannelShieldNumber (300a,02b2)
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	ChannelShieldID
	ChannelShieldID (300a,02b3) vr=SH, vm=1, type=2C.
DcmLongString	ChannelShieldName
	ChannelShieldName (300a,02b4) vr=LO, vm=1, type=3.
DcmDecimalString	ChannelShieldNominalThickness
	ChannelShieldNominalThickness (300a,02b8) vr=DS, vm=1, type=3.
DcmDecimalString	ChannelShieldNominalTransmission
	ChannelShieldNominalTransmission (300a,02ba) vr=DS, vm=1, type=3.
DcmIntegerString	ChannelShieldNumber
	ChannelShieldNumber (300a,02b2) vr=IS, 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

DRTChannelShieldSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTChannelShieldSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTChannelShieldSequence::Item::getChannelShieldID	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ChannelShieldID (300a,02b3)

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

get ChannelShieldName (300a,02b4)

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

get ChannelShieldNominalThickness (300a,02b8)

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

get ChannelShieldNominalThickness (300a,02b8)

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

get ChannelShieldNominalTransmission (300a,02ba)

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

get ChannelShieldNominalTransmission (300a,02ba)

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

get ChannelShieldNumber (300a,02b2)

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

get ChannelShieldNumber (300a,02b2)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTChannelShieldSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTChannelShieldSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ChannelShieldID (300a,02b3)

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

set ChannelShieldName (300a,02b4)

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

set ChannelShieldNominalThickness (300a,02b8)

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

set ChannelShieldNominalTransmission (300a,02ba)

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

set ChannelShieldNumber (300a,02b2)

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 DRTChannelShieldSequence::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 DRTChannelShieldSequence::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 DRTChannelShieldSequence::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/drtcshs.h