Inheritance diagram for DRTDoseCalibrationConditionsSequence::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)
	assignment 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	getAbsorbedDoseToMetersetRatio (Float64 &value, const unsigned long pos=0) const
	get AbsorbedDoseToMetersetRatio (300c,0121) More...

OFCondition	getCalibrationDateTime (OFString &value, const signed long pos=0) const
	get CalibrationDateTime (0018,1203) More...

OFCondition	getCalibrationReferencePointDepth (Float64 &value, const unsigned long pos=0) const
	get CalibrationReferencePointDepth (300c,0124) More...

OFCondition	getDelineatedRadiationFieldSize (Float64 &value, const unsigned long pos=0) const
	get DelineatedRadiationFieldSize (300c,0122) More...

OFCondition	getSourceToSurfaceDistance (OFString &value, const signed long pos=0) const
	get SourceToSurfaceDistance (300a,0130) More...

OFCondition	getSourceToSurfaceDistance (Float64 &value, const unsigned long pos=0) const
	get SourceToSurfaceDistance (300a,0130) More...

OFCondition	setAbsorbedDoseToMetersetRatio (const Float64 value, const unsigned long pos=0)
	set AbsorbedDoseToMetersetRatio (300c,0121) More...

OFCondition	setCalibrationDateTime (const OFString &value, const OFBool check=OFTrue)
	set CalibrationDateTime (0018,1203) More...

OFCondition	setCalibrationReferencePointDepth (const Float64 value, const unsigned long pos=0)
	set CalibrationReferencePointDepth (300c,0124) More...

OFCondition	setDelineatedRadiationFieldSize (const Float64 value, const unsigned long pos=0)
	set DelineatedRadiationFieldSize (300c,0122) More...

OFCondition	setSourceToSurfaceDistance (const OFString &value, const OFBool check=OFTrue)
	set SourceToSurfaceDistance (300a,0130) More...

Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item

DcmFloatingPointDouble	AbsorbedDoseToMetersetRatio
	AbsorbedDoseToMetersetRatio (300c,0121) vr=FD, vm=1, type=1.

DcmDateTime	CalibrationDateTime
	CalibrationDateTime (0018,1203) vr=DT, vm=1, type=2.

DcmFloatingPointDouble	CalibrationReferencePointDepth
	CalibrationReferencePointDepth (300c,0124) vr=FD, vm=1, type=1.

DcmFloatingPointDouble	DelineatedRadiationFieldSize
	DelineatedRadiationFieldSize (300c,0122) vr=FD, vm=2, type=1.

DcmDecimalString	SourceToSurfaceDistance
	SourceToSurfaceDistance (300a,0130) vr=DS, vm=1, type=1.

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

◆ Item() [1/2]

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

◆ Item() [2/2]

DRTDoseCalibrationConditionsSequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

◆ getAbsorbedDoseToMetersetRatio()

OFCondition DRTDoseCalibrationConditionsSequence::Item::getAbsorbedDoseToMetersetRatio	(	Float64 &	value,
		const unsigned long	pos = `0`
	)		const

get AbsorbedDoseToMetersetRatio (300c,0121)

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

◆ getCalibrationDateTime()

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

get CalibrationDateTime (0018,1203)

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

◆ getCalibrationReferencePointDepth()

OFCondition DRTDoseCalibrationConditionsSequence::Item::getCalibrationReferencePointDepth	(	Float64 &	value,
		const unsigned long	pos = `0`
	)		const

get CalibrationReferencePointDepth (300c,0124)

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

◆ getDelineatedRadiationFieldSize()

OFCondition DRTDoseCalibrationConditionsSequence::Item::getDelineatedRadiationFieldSize	(	Float64 &	value,
		const unsigned long	pos = `0`
	)		const

get DelineatedRadiationFieldSize (300c,0122)

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

◆ getSourceToSurfaceDistance() [1/2]

OFCondition DRTDoseCalibrationConditionsSequence::Item::getSourceToSurfaceDistance	(	Float64 &	value,
		const unsigned long	pos = `0`
	)		const

get SourceToSurfaceDistance (300a,0130)

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

◆ getSourceToSurfaceDistance() [2/2]

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

get SourceToSurfaceDistance (300a,0130)

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

◆ isEmpty()

OFBool DRTDoseCalibrationConditionsSequence::Item::isEmpty ( )

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTDoseCalibrationConditionsSequence::Item::isValid ( ) const

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

Returns: OFTrue if item is valid, OFFalse otherwise

◆ operator=()

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

assignment operator

Parameters

copy	item object to be copied

Returns: reference to this object

◆ read()

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

◆ setAbsorbedDoseToMetersetRatio()

OFCondition DRTDoseCalibrationConditionsSequence::Item::setAbsorbedDoseToMetersetRatio	(	const Float64	value,
		const unsigned long	pos = `0`
	)

set AbsorbedDoseToMetersetRatio (300c,0121)

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

◆ setCalibrationDateTime()

OFCondition DRTDoseCalibrationConditionsSequence::Item::setCalibrationDateTime	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set CalibrationDateTime (0018,1203)

Parameters

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DT) and VM (1) if enabled

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

◆ setCalibrationReferencePointDepth()

OFCondition DRTDoseCalibrationConditionsSequence::Item::setCalibrationReferencePointDepth	(	const Float64	value,
		const unsigned long	pos = `0`
	)

set CalibrationReferencePointDepth (300c,0124)

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

◆ setDelineatedRadiationFieldSize()

OFCondition DRTDoseCalibrationConditionsSequence::Item::setDelineatedRadiationFieldSize	(	const Float64	value,
		const unsigned long	pos = `0`
	)

set DelineatedRadiationFieldSize (300c,0122)

Parameters

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

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

◆ setSourceToSurfaceDistance()

OFCondition DRTDoseCalibrationConditionsSequence::Item::setSourceToSurfaceDistance	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set SourceToSurfaceDistance (300a,0130)

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

◆ write()

OFCondition DRTDoseCalibrationConditionsSequence::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/drtdccs.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Item() [1/2]

◆ Item() [2/2]

Member Function Documentation

◆ getAbsorbedDoseToMetersetRatio()

◆ getCalibrationDateTime()

◆ getCalibrationReferencePointDepth()

◆ getDelineatedRadiationFieldSize()

◆ getSourceToSurfaceDistance() [1/2]

◆ getSourceToSurfaceDistance() [2/2]

◆ isEmpty()

◆ isValid()

◆ operator=()

◆ read()

◆ setAbsorbedDoseToMetersetRatio()

◆ setCalibrationDateTime()

◆ setCalibrationReferencePointDepth()

◆ setDelineatedRadiationFieldSize()

◆ setSourceToSurfaceDistance()

◆ write()