Inheritance diagram for DRTExposureSequence::Item:

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	getDiaphragmPosition (OFString &value, const signed long pos=0) const
	get DiaphragmPosition (3002,0034)
OFCondition	getDiaphragmPosition (Float64 &value, const unsigned long pos=0) const
	get DiaphragmPosition (3002,0034)
OFCondition	getDiaphragmPosition (OFVector< Float64 > &value) const
	get DiaphragmPosition (3002,0034)
OFCondition	getExposureTime (OFString &value, const signed long pos=0) const
	get ExposureTime (0018,1150)
OFCondition	getExposureTime (Sint32 &value, const unsigned long pos=0) const
	get ExposureTime (0018,1150)
OFCondition	getFluenceDataScale (OFString &value, const signed long pos=0) const
	get FluenceDataScale (3002,0042)
OFCondition	getFluenceDataScale (Float64 &value, const unsigned long pos=0) const
	get FluenceDataScale (3002,0042)
OFCondition	getFluenceDataSource (OFString &value, const signed long pos=0) const
	get FluenceDataSource (3002,0041)
OFCondition	getKVP (OFString &value, const signed long pos=0) const
	get KVP (0018,0060)
OFCondition	getKVP (Float64 &value, const unsigned long pos=0) const
	get KVP (0018,0060)
OFCondition	getMetersetExposure (OFString &value, const signed long pos=0) const
	get MetersetExposure (3002,0032)
OFCondition	getMetersetExposure (Float64 &value, const unsigned long pos=0) const
	get MetersetExposure (3002,0032)
OFCondition	getNumberOfBlocks (OFString &value, const signed long pos=0) const
	get NumberOfBlocks (300a,00f0)
OFCondition	getNumberOfBlocks (Sint32 &value, const unsigned long pos=0) const
	get NumberOfBlocks (300a,00f0)
OFCondition	getReferencedFrameNumber (OFString &value, const signed long pos=0) const
	get ReferencedFrameNumber (0008,1160)
OFCondition	getReferencedFrameNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedFrameNumber (0008,1160)
OFCondition	getXRayTubeCurrent (OFString &value, const signed long pos=0) const
	get XRayTubeCurrent (0018,1151)
OFCondition	getXRayTubeCurrent (Sint32 &value, const unsigned long pos=0) const
	get XRayTubeCurrent (0018,1151)
DRTApplicatorSequenceInRTImageModule &	getApplicatorSequence ()
	get ApplicatorSequence (300a,0107)
const DRTApplicatorSequenceInRTImageModule &	getApplicatorSequence () const
	get ApplicatorSequence (300a,0107)
DRTBeamLimitingDeviceSequenceInRTImageModule &	getBeamLimitingDeviceSequence ()
	get BeamLimitingDeviceSequence (300a,00b6)
const DRTBeamLimitingDeviceSequenceInRTImageModule &	getBeamLimitingDeviceSequence () const
	get BeamLimitingDeviceSequence (300a,00b6)
DRTBlockSequenceInRTImageModule &	getBlockSequence ()
	get BlockSequence (300a,00f4)
const DRTBlockSequenceInRTImageModule &	getBlockSequence () const
	get BlockSequence (300a,00f4)
OFCondition	setDiaphragmPosition (const OFString &value, const OFBool check=OFTrue)
	set DiaphragmPosition (3002,0034)
OFCondition	setExposureTime (const OFString &value, const OFBool check=OFTrue)
	set ExposureTime (0018,1150)
OFCondition	setFluenceDataScale (const OFString &value, const OFBool check=OFTrue)
	set FluenceDataScale (3002,0042)
OFCondition	setFluenceDataSource (const OFString &value, const OFBool check=OFTrue)
	set FluenceDataSource (3002,0041)
OFCondition	setKVP (const OFString &value, const OFBool check=OFTrue)
	set KVP (0018,0060)
OFCondition	setMetersetExposure (const OFString &value, const OFBool check=OFTrue)
	set MetersetExposure (3002,0032)
OFCondition	setNumberOfBlocks (const OFString &value, const OFBool check=OFTrue)
	set NumberOfBlocks (300a,00f0)
OFCondition	setReferencedFrameNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedFrameNumber (0008,1160)
OFCondition	setXRayTubeCurrent (const OFString &value, const OFBool check=OFTrue)
	set XRayTubeCurrent (0018,1151)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DRTApplicatorSequenceInRTImageModule	ApplicatorSequence
	ApplicatorSequence (300a,0107) vr=SQ, vm=1, type=3.
DRTBeamLimitingDeviceSequenceInRTImageModule	BeamLimitingDeviceSequence
	BeamLimitingDeviceSequence (300a,00b6) vr=SQ, vm=1, type=3.
DRTBlockSequenceInRTImageModule	BlockSequence
	BlockSequence (300a,00f4) vr=SQ, vm=1, type=2C.
DcmDecimalString	DiaphragmPosition
	DiaphragmPosition (3002,0034) vr=DS, vm=4, type=3.
DcmIntegerString	ExposureTime
	ExposureTime (0018,1150) vr=IS, vm=1, type=2C.
DcmDecimalString	FluenceDataScale
	FluenceDataScale (3002,0042) vr=DS, vm=1, type=3.
DcmCodeString	FluenceDataSource
	FluenceDataSource (3002,0041) vr=CS, vm=1, type=1.
DcmDecimalString	KVP
	KVP (0018,0060) vr=DS, vm=1, type=2C.
DcmDecimalString	MetersetExposure
	MetersetExposure (3002,0032) vr=DS, vm=1, type=2C.
DcmIntegerString	NumberOfBlocks
	NumberOfBlocks (300a,00f0) vr=IS, vm=1, type=1C.
DcmIntegerString	ReferencedFrameNumber
	ReferencedFrameNumber (0008,1160) vr=IS, vm=1-n, type=1C.
DcmIntegerString	XRayTubeCurrent
	XRayTubeCurrent (0018,1151) vr=IS, vm=1, type=2C.

Detailed Description

Item class.

Constructor & Destructor Documentation

DRTExposureSequence::Item::Item ( const OFBool emptyDefaultItem = OFFalse )

(default) constructor

Parameters:

emptyDefaultItem flag used to mark the empty default item

DRTExposureSequence::Item::Item ( const Item & copy )

copy constructor

Parameters:

copy	item object to be copied

Member Function Documentation

DRTApplicatorSequenceInRTImageModule& DRTExposureSequence::Item::getApplicatorSequence ( ) [inline]

get ApplicatorSequence (300a,0107)

Returns:: reference to sequence element

const DRTApplicatorSequenceInRTImageModule& DRTExposureSequence::Item::getApplicatorSequence ( ) const [inline]

get ApplicatorSequence (300a,0107)

Returns:: const reference to sequence element

DRTBeamLimitingDeviceSequenceInRTImageModule& DRTExposureSequence::Item::getBeamLimitingDeviceSequence ( ) [inline]

get BeamLimitingDeviceSequence (300a,00b6)

Returns:: reference to sequence element

const DRTBeamLimitingDeviceSequenceInRTImageModule& DRTExposureSequence::Item::getBeamLimitingDeviceSequence ( ) const [inline]

get BeamLimitingDeviceSequence (300a,00b6)

Returns:: const reference to sequence element

DRTBlockSequenceInRTImageModule& DRTExposureSequence::Item::getBlockSequence ( ) [inline]

get BlockSequence (300a,00f4)

Returns:: reference to sequence element

const DRTBlockSequenceInRTImageModule& DRTExposureSequence::Item::getBlockSequence ( ) const [inline]

get BlockSequence (300a,00f4)

Returns:: const reference to sequence element

OFCondition DRTExposureSequence::Item::getDiaphragmPosition	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get DiaphragmPosition (3002,0034)

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

get DiaphragmPosition (3002,0034)

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 DRTExposureSequence::Item::getDiaphragmPosition ( OFVector< Float64 > & value ) const

get DiaphragmPosition (3002,0034)

Parameters:

value reference to variable in which the value(s) should be stored

Returns:: status, EC_Normal if successful, an error code otherwise

OFCondition DRTExposureSequence::Item::getExposureTime	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ExposureTime (0018,1150)

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

get ExposureTime (0018,1150)

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

get FluenceDataScale (3002,0042)

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

get FluenceDataScale (3002,0042)

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

get FluenceDataSource (3002,0041)

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

get KVP (0018,0060)

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

get KVP (0018,0060)

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

get MetersetExposure (3002,0032)

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

get MetersetExposure (3002,0032)

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

get NumberOfBlocks (300a,00f0)

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

get NumberOfBlocks (300a,00f0)

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

get ReferencedFrameNumber (0008,1160)

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

get ReferencedFrameNumber (0008,1160)

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

get XRayTubeCurrent (0018,1151)

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

get XRayTubeCurrent (0018,1151)

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 DRTExposureSequence::Item::isEmpty ( )

check if item is empty

Returns:: OFTrue if item is empty, OFFalse otherwise

OFBool DRTExposureSequence::Item::isValid ( ) const

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

Returns:: OFTrue if item is valid, OFFalse otherwise

Item& DRTExposureSequence::Item::operator= ( const Item & copy )

assigment operator

Parameters:

copy	item object to be copied

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

set DiaphragmPosition (3002,0034)

Parameters:

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (4) if enabled

Returns:: status, EC_Normal if successful, an error code otherwise

OFCondition DRTExposureSequence::Item::setExposureTime	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ExposureTime (0018,1150)

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

set FluenceDataScale (3002,0042)

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

set FluenceDataSource (3002,0041)

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

set KVP (0018,0060)

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

set MetersetExposure (3002,0032)

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

set NumberOfBlocks (300a,00f0)

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

set ReferencedFrameNumber (0008,1160)

Parameters:

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (IS) and VM (1-n) if enabled

Returns:: status, EC_Normal if successful, an error code otherwise

OFCondition DRTExposureSequence::Item::setXRayTubeCurrent	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set XRayTubeCurrent (0018,1151)

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 DRTExposureSequence::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/drtes.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation