DRTFluenceMapSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTFluenceMapSequence::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	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	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)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmDecimalString	FluenceDataScale
	FluenceDataScale (3002,0042) vr=DS, vm=1, type=3.
DcmCodeString	FluenceDataSource
	FluenceDataSource (3002,0041) vr=CS, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTFluenceMapSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTFluenceMapSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTFluenceMapSequence::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 DRTFluenceMapSequence::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 DRTFluenceMapSequence::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

OFBool DRTFluenceMapSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTFluenceMapSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTFluenceMapSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

OFCondition DRTFluenceMapSequence::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 DRTFluenceMapSequence::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 DRTFluenceMapSequence::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 DRTFluenceMapSequence::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/drtfms.h