DRTMotionSynchronizationSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTMotionSynchronizationSequence::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	getRespiratoryMotionCompensationTechnique (OFString &value, const signed long pos=0) const
	get RespiratoryMotionCompensationTechnique (0018,9170)
OFCondition	getRespiratoryMotionCompensationTechniqueDescription (OFString &value, const signed long pos=0) const
	get RespiratoryMotionCompensationTechniqueDescription (0018,9185)
OFCondition	getRespiratorySignalSource (OFString &value, const signed long pos=0) const
	get RespiratorySignalSource (0018,9171)
OFCondition	getRespiratorySignalSourceID (OFString &value, const signed long pos=0) const
	get RespiratorySignalSourceID (0018,9186)
OFCondition	setRespiratoryMotionCompensationTechnique (const OFString &value, const OFBool check=OFTrue)
	set RespiratoryMotionCompensationTechnique (0018,9170)
OFCondition	setRespiratoryMotionCompensationTechniqueDescription (const OFString &value, const OFBool check=OFTrue)
	set RespiratoryMotionCompensationTechniqueDescription (0018,9185)
OFCondition	setRespiratorySignalSource (const OFString &value, const OFBool check=OFTrue)
	set RespiratorySignalSource (0018,9171)
OFCondition	setRespiratorySignalSourceID (const OFString &value, const OFBool check=OFTrue)
	set RespiratorySignalSourceID (0018,9186)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmCodeString	RespiratoryMotionCompensationTechnique
	RespiratoryMotionCompensationTechnique (0018,9170) vr=CS, vm=1, type=1.
DcmShortText	RespiratoryMotionCompensationTechniqueDescription
	RespiratoryMotionCompensationTechniqueDescription (0018,9185) vr=ST, vm=1, type=3.
DcmCodeString	RespiratorySignalSource
	RespiratorySignalSource (0018,9171) vr=CS, vm=1, type=1.
DcmShortString	RespiratorySignalSourceID
	RespiratorySignalSourceID (0018,9186) vr=SH, vm=1, type=3.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTMotionSynchronizationSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTMotionSynchronizationSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTMotionSynchronizationSequence::Item::getRespiratoryMotionCompensationTechnique	(	OFString &	value,
		const signed long	pos = 0
	)		const

get RespiratoryMotionCompensationTechnique (0018,9170)

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

get RespiratoryMotionCompensationTechniqueDescription (0018,9185)

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

get RespiratorySignalSource (0018,9171)

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

get RespiratorySignalSourceID (0018,9186)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTMotionSynchronizationSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTMotionSynchronizationSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set RespiratoryMotionCompensationTechnique (0018,9170)

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

set RespiratoryMotionCompensationTechniqueDescription (0018,9185)

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

set RespiratorySignalSource (0018,9171)

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

set RespiratorySignalSourceID (0018,9186)

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 DRTMotionSynchronizationSequence::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/drtmss.h