DRTFixationDeviceSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTFixationDeviceSequence::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	getFixationDeviceDescription (OFString &value, const signed long pos=0) const
	get FixationDeviceDescription (300a,0196)
OFCondition	getFixationDeviceLabel (OFString &value, const signed long pos=0) const
	get FixationDeviceLabel (300a,0194)
OFCondition	getFixationDevicePitchAngle (Float32 &value, const unsigned long pos=0) const
	get FixationDevicePitchAngle (300a,0199)
OFCondition	getFixationDevicePosition (OFString &value, const signed long pos=0) const
	get FixationDevicePosition (300a,0198)
OFCondition	getFixationDeviceRollAngle (Float32 &value, const unsigned long pos=0) const
	get FixationDeviceRollAngle (300a,019a)
OFCondition	getFixationDeviceType (OFString &value, const signed long pos=0) const
	get FixationDeviceType (300a,0192)
OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9)
OFCondition	setFixationDeviceDescription (const OFString &value, const OFBool check=OFTrue)
	set FixationDeviceDescription (300a,0196)
OFCondition	setFixationDeviceLabel (const OFString &value, const OFBool check=OFTrue)
	set FixationDeviceLabel (300a,0194)
OFCondition	setFixationDevicePitchAngle (const Float32 value, const unsigned long pos=0)
	set FixationDevicePitchAngle (300a,0199)
OFCondition	setFixationDevicePosition (const OFString &value, const OFBool check=OFTrue)
	set FixationDevicePosition (300a,0198)
OFCondition	setFixationDeviceRollAngle (const Float32 value, const unsigned long pos=0)
	set FixationDeviceRollAngle (300a,019a)
OFCondition	setFixationDeviceType (const OFString &value, const OFBool check=OFTrue)
	set FixationDeviceType (300a,0192)
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	FixationDeviceDescription
	FixationDeviceDescription (300a,0196) vr=ST, vm=1, type=3.
DcmShortString	FixationDeviceLabel
	FixationDeviceLabel (300a,0194) vr=SH, vm=1, type=2C.
DcmFloatingPointSingle	FixationDevicePitchAngle
	FixationDevicePitchAngle (300a,0199) vr=FL, vm=1, type=3.
DcmShortString	FixationDevicePosition
	FixationDevicePosition (300a,0198) vr=SH, vm=1, type=3.
DcmFloatingPointSingle	FixationDeviceRollAngle
	FixationDeviceRollAngle (300a,019a) vr=FL, vm=1, type=3.
DcmCodeString	FixationDeviceType
	FixationDeviceType (300a,0192) vr=CS, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTFixationDeviceSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTFixationDeviceSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

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

get FixationDeviceDescription (300a,0196)

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

get FixationDeviceLabel (300a,0194)

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 DRTFixationDeviceSequence::Item::getFixationDevicePitchAngle	(	Float32 &	value,
		const unsigned long	pos = 0
	)		const

get FixationDevicePitchAngle (300a,0199)

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

get FixationDevicePosition (300a,0198)

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 DRTFixationDeviceSequence::Item::getFixationDeviceRollAngle	(	Float32 &	value,
		const unsigned long	pos = 0
	)		const

get FixationDeviceRollAngle (300a,019a)

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

get FixationDeviceType (300a,0192)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTFixationDeviceSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTFixationDeviceSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set FixationDeviceDescription (300a,0196)

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

set FixationDeviceLabel (300a,0194)

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 DRTFixationDeviceSequence::Item::setFixationDevicePitchAngle	(	const Float32	value,
		const unsigned long	pos = 0
	)

set FixationDevicePitchAngle (300a,0199)

Parameters:

value	value to be set (should be valid for this VR)
pos	index of the value to be set (0..vm-1), vm=1

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTFixationDeviceSequence::Item::setFixationDevicePosition	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set FixationDevicePosition (300a,0198)

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 DRTFixationDeviceSequence::Item::setFixationDeviceRollAngle	(	const Float32	value,
		const unsigned long	pos = 0
	)

set FixationDeviceRollAngle (300a,019a)

Parameters:

value	value to be set (should be valid for this VR)
pos	index of the value to be set (0..vm-1), vm=1

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTFixationDeviceSequence::Item::setFixationDeviceType	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set FixationDeviceType (300a,0192)

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 DRTFixationDeviceSequence::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/drtfds.h