DRTSetupDeviceSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTSetupDeviceSequence::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	getSetupDeviceDescription (OFString &value, const signed long pos=0) const
	get SetupDeviceDescription (300a,01ba)
OFCondition	getSetupDeviceLabel (OFString &value, const signed long pos=0) const
	get SetupDeviceLabel (300a,01b8)
OFCondition	getSetupDeviceParameter (OFString &value, const signed long pos=0) const
	get SetupDeviceParameter (300a,01bc)
OFCondition	getSetupDeviceParameter (Float64 &value, const unsigned long pos=0) const
	get SetupDeviceParameter (300a,01bc)
OFCondition	getSetupDeviceType (OFString &value, const signed long pos=0) const
	get SetupDeviceType (300a,01b6)
OFCondition	getSetupReferenceDescription (OFString &value, const signed long pos=0) const
	get SetupReferenceDescription (300a,01d0)
OFCondition	setSetupDeviceDescription (const OFString &value, const OFBool check=OFTrue)
	set SetupDeviceDescription (300a,01ba)
OFCondition	setSetupDeviceLabel (const OFString &value, const OFBool check=OFTrue)
	set SetupDeviceLabel (300a,01b8)
OFCondition	setSetupDeviceParameter (const OFString &value, const OFBool check=OFTrue)
	set SetupDeviceParameter (300a,01bc)
OFCondition	setSetupDeviceType (const OFString &value, const OFBool check=OFTrue)
	set SetupDeviceType (300a,01b6)
OFCondition	setSetupReferenceDescription (const OFString &value, const OFBool check=OFTrue)
	set SetupReferenceDescription (300a,01d0)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmShortText	SetupDeviceDescription
	SetupDeviceDescription (300a,01ba) vr=ST, vm=1, type=3.
DcmShortString	SetupDeviceLabel
	SetupDeviceLabel (300a,01b8) vr=SH, vm=1, type=2C.
DcmDecimalString	SetupDeviceParameter
	SetupDeviceParameter (300a,01bc) vr=DS, vm=1, type=2C.
DcmCodeString	SetupDeviceType
	SetupDeviceType (300a,01b6) vr=CS, vm=1, type=1C.
DcmShortText	SetupReferenceDescription
	SetupReferenceDescription (300a,01d0) vr=ST, vm=1, type=3.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTSetupDeviceSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTSetupDeviceSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTSetupDeviceSequence::Item::getSetupDeviceDescription	(	OFString &	value,
		const signed long	pos = 0
	)		const

get SetupDeviceDescription (300a,01ba)

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

get SetupDeviceLabel (300a,01b8)

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

get SetupDeviceParameter (300a,01bc)

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

get SetupDeviceParameter (300a,01bc)

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

get SetupDeviceType (300a,01b6)

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

get SetupReferenceDescription (300a,01d0)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTSetupDeviceSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTSetupDeviceSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set SetupDeviceDescription (300a,01ba)

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

set SetupDeviceLabel (300a,01b8)

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

set SetupDeviceParameter (300a,01bc)

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

set SetupDeviceType (300a,01b6)

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

set SetupReferenceDescription (300a,01d0)

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 DRTSetupDeviceSequence::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/drtsds.h