DRTBeamDoseVerificationControlPointSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTBeamDoseVerificationControlPointSequence::Item:

Public Member Functions
	Item (const OFBool emptyDefaultItem=OFFalse)
	(default) constructor More...
	Item (const Item &copy)
	copy constructor More...
virtual	~Item ()
	destructor
Item &	operator= (const Item &copy)
	assigment operator More...
void	clear ()
	clear all internal member variables
OFBool	isEmpty ()
	check if item is empty More...
OFBool	isValid () const
	check if item is valid, i.e. not the empty default item More...
OFCondition	read (DcmItem &item)
	read elements from sequence item More...
OFCondition	write (DcmItem &item)
	write elements to sequence item More...
OFCondition	getAverageBeamDosePointDepth (Float32 &value, const unsigned long pos=0) const
	get AverageBeamDosePointDepth (300a,008d) More...
OFCondition	getAverageBeamDosePointEquivalentDepth (Float32 &value, const unsigned long pos=0) const
	get AverageBeamDosePointEquivalentDepth (300a,008e) More...
OFCondition	getAverageBeamDosePointSSD (Float32 &value, const unsigned long pos=0) const
	get AverageBeamDosePointSSD (300a,008f) More...
OFCondition	getAverageBeamDosePointSourceToExternalContourDistance (Float32 &value, const unsigned long pos=0) const
	get AverageBeamDosePointSourceToExternalContourDistance (300a,0131) More...
OFCondition	getCumulativeMetersetWeight (OFString &value, const signed long pos=0) const
	get CumulativeMetersetWeight (300a,0134) More...
OFCondition	getCumulativeMetersetWeight (Float64 &value, const unsigned long pos=0) const
	get CumulativeMetersetWeight (300a,0134) More...
OFCondition	getReferencedControlPointIndex (OFString &value, const signed long pos=0) const
	get ReferencedControlPointIndex (300c,00f0) More...
OFCondition	getReferencedControlPointIndex (Sint32 &value, const unsigned long pos=0) const
	get ReferencedControlPointIndex (300c,00f0) More...
OFCondition	setAverageBeamDosePointDepth (const Float32 value, const unsigned long pos=0)
	set AverageBeamDosePointDepth (300a,008d) More...
OFCondition	setAverageBeamDosePointEquivalentDepth (const Float32 value, const unsigned long pos=0)
	set AverageBeamDosePointEquivalentDepth (300a,008e) More...
OFCondition	setAverageBeamDosePointSSD (const Float32 value, const unsigned long pos=0)
	set AverageBeamDosePointSSD (300a,008f) More...
OFCondition	setAverageBeamDosePointSourceToExternalContourDistance (const Float32 value, const unsigned long pos=0)
	set AverageBeamDosePointSourceToExternalContourDistance (300a,0131) More...
OFCondition	setCumulativeMetersetWeight (const OFString &value, const OFBool check=OFTrue)
	set CumulativeMetersetWeight (300a,0134) More...
OFCondition	setReferencedControlPointIndex (const OFString &value, const OFBool check=OFTrue)
	set ReferencedControlPointIndex (300c,00f0) More...

Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmFloatingPointSingle	AverageBeamDosePointDepth
	AverageBeamDosePointDepth (300a,008d) vr=FL, vm=1, type=2C.
DcmFloatingPointSingle	AverageBeamDosePointEquivalentDepth
	AverageBeamDosePointEquivalentDepth (300a,008e) vr=FL, vm=1, type=2C.
DcmFloatingPointSingle	AverageBeamDosePointSSD
	AverageBeamDosePointSSD (300a,008f) vr=FL, vm=1, type=2C.
DcmFloatingPointSingle	AverageBeamDosePointSourceToExternalContourDistance
	AverageBeamDosePointSourceToExternalContourDistance (300a,0131) vr=FL, vm=1, type=3.
DcmDecimalString	CumulativeMetersetWeight
	CumulativeMetersetWeight (300a,0134) vr=DS, vm=1, type=1.
DcmIntegerString	ReferencedControlPointIndex
	ReferencedControlPointIndex (300c,00f0) vr=IS, vm=1, type=1C.

Additional Inherited Members
Protected Member Functions inherited from DRTTypes
virtual	~DRTTypes ()
	destructor. More...
Static Protected Member Functions inherited from DRTTypes
static OFCondition	addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement *element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
	add given element to the dataset. More...
static OFCondition	getElementFromDataset (DcmItem &dataset, DcmElement &element)
	get element from dataset More...
static OFCondition	getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0)
	get string value from element More...
static OFCondition	getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
	get string value from dataset More...
static OFCondition	putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
	put string value to dataset More...
static OFBool	checkElementValue (DcmElement &element, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL)
	check element value for correct value multiplicity and type More...
static OFCondition	getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
	get element from dataset and check it for correct value multiplicity and type. More...
static OFCondition	getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, const char *moduleName=NULL)
	get string value from dataset and check it for correct value multiplicity and type. More...

Detailed Description

Item class.

Constructor & Destructor Documentation

DRTBeamDoseVerificationControlPointSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters

emptyDefaultItem

flag used to mark the empty default item

DRTBeamDoseVerificationControlPointSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

OFCondition DRTBeamDoseVerificationControlPointSequence::Item::getAverageBeamDosePointDepth	(	Float32 &	value,
		const unsigned long	pos = 0
	)		const

get AverageBeamDosePointDepth (300a,008d)

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

get AverageBeamDosePointEquivalentDepth (300a,008e)

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

get AverageBeamDosePointSourceToExternalContourDistance (300a,0131)

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

get AverageBeamDosePointSSD (300a,008f)

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

get CumulativeMetersetWeight (300a,0134)

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

get CumulativeMetersetWeight (300a,0134)

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

get ReferencedControlPointIndex (300c,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 DRTBeamDoseVerificationControlPointSequence::Item::getReferencedControlPointIndex	(	Sint32 &	value,
		const unsigned long	pos = 0
	)		const

get ReferencedControlPointIndex (300c,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

OFBool DRTBeamDoseVerificationControlPointSequence::Item::isEmpty

(

)

check if item is empty

Returns

OFTrue if item is empty, OFFalse otherwise

OFBool DRTBeamDoseVerificationControlPointSequence::Item::isValid

(

)

const

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

Returns

OFTrue if item is valid, OFFalse otherwise

Item& DRTBeamDoseVerificationControlPointSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters

copy	item object to be copied

Returns

reference to this object

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

set AverageBeamDosePointDepth (300a,008d)

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

set AverageBeamDosePointEquivalentDepth (300a,008e)

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

set AverageBeamDosePointSourceToExternalContourDistance (300a,0131)

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

set AverageBeamDosePointSSD (300a,008f)

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

set CumulativeMetersetWeight (300a,0134)

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

set ReferencedControlPointIndex (300c,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 DRTBeamDoseVerificationControlPointSequence::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/drtbvcps.h