DRTReferencedBeamSequenceInRTFractionSchemeModule::Item Class Reference

Item class. More...

Inheritance diagram for DRTReferencedBeamSequenceInRTFractionSchemeModule::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	getBeamDose (OFString &value, const signed long pos=0) const
	get BeamDose (300a,0084)
OFCondition	getBeamDose (Float64 &value, const unsigned long pos=0) const
	get BeamDose (300a,0084)
OFCondition	getBeamDosePointDepth (Float32 &value, const unsigned long pos=0) const
	get BeamDosePointDepth (300a,0088)
OFCondition	getBeamDosePointEquivalentDepth (Float32 &value, const unsigned long pos=0) const
	get BeamDosePointEquivalentDepth (300a,0089)
OFCondition	getBeamDosePointSSD (Float32 &value, const unsigned long pos=0) const
	get BeamDosePointSSD (300a,008a)
OFCondition	getBeamDoseSpecificationPoint (OFString &value, const signed long pos=0) const
	get BeamDoseSpecificationPoint (300a,0082)
OFCondition	getBeamDoseSpecificationPoint (Float64 &value, const unsigned long pos=0) const
	get BeamDoseSpecificationPoint (300a,0082)
OFCondition	getBeamDoseSpecificationPoint (OFVector< Float64 > &value) const
	get BeamDoseSpecificationPoint (300a,0082)
OFCondition	getBeamMeterset (OFString &value, const signed long pos=0) const
	get BeamMeterset (300a,0086)
OFCondition	getBeamMeterset (Float64 &value, const unsigned long pos=0) const
	get BeamMeterset (300a,0086)
OFCondition	getReferencedBeamNumber (OFString &value, const signed long pos=0) const
	get ReferencedBeamNumber (300c,0006)
OFCondition	getReferencedBeamNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedBeamNumber (300c,0006)
OFCondition	setBeamDose (const OFString &value, const OFBool check=OFTrue)
	set BeamDose (300a,0084)
OFCondition	setBeamDosePointDepth (const Float32 value, const unsigned long pos=0)
	set BeamDosePointDepth (300a,0088)
OFCondition	setBeamDosePointEquivalentDepth (const Float32 value, const unsigned long pos=0)
	set BeamDosePointEquivalentDepth (300a,0089)
OFCondition	setBeamDosePointSSD (const Float32 value, const unsigned long pos=0)
	set BeamDosePointSSD (300a,008a)
OFCondition	setBeamDoseSpecificationPoint (const OFString &value, const OFBool check=OFTrue)
	set BeamDoseSpecificationPoint (300a,0082)
OFCondition	setBeamMeterset (const OFString &value, const OFBool check=OFTrue)
	set BeamMeterset (300a,0086)
OFCondition	setReferencedBeamNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedBeamNumber (300c,0006)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmDecimalString	BeamDose
	BeamDose (300a,0084) vr=DS, vm=1, type=3.
DcmFloatingPointSingle	BeamDosePointDepth
	BeamDosePointDepth (300a,0088) vr=FL, vm=1, type=3.
DcmFloatingPointSingle	BeamDosePointEquivalentDepth
	BeamDosePointEquivalentDepth (300a,0089) vr=FL, vm=1, type=3.
DcmFloatingPointSingle	BeamDosePointSSD
	BeamDosePointSSD (300a,008a) vr=FL, vm=1, type=3.
DcmDecimalString	BeamDoseSpecificationPoint
	BeamDoseSpecificationPoint (300a,0082) vr=DS, vm=3, type=3.
DcmDecimalString	BeamMeterset
	BeamMeterset (300a,0086) vr=DS, vm=1, type=3.
DcmIntegerString	ReferencedBeamNumber
	ReferencedBeamNumber (300c,0006) vr=IS, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTReferencedBeamSequenceInRTFractionSchemeModule::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTReferencedBeamSequenceInRTFractionSchemeModule::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTReferencedBeamSequenceInRTFractionSchemeModule::Item::getBeamDose	(	OFString &	value,
		const signed long	pos = 0
	)		const

get BeamDose (300a,0084)

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

get BeamDose (300a,0084)

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

get BeamDosePointDepth (300a,0088)

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

get BeamDosePointEquivalentDepth (300a,0089)

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

get BeamDosePointSSD (300a,008a)

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

get BeamDoseSpecificationPoint (300a,0082)

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

get BeamDoseSpecificationPoint (300a,0082)

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 DRTReferencedBeamSequenceInRTFractionSchemeModule::Item::getBeamDoseSpecificationPoint

(

OFVector< Float64 > &

value

)

const

get BeamDoseSpecificationPoint (300a,0082)

Parameters:

value

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTReferencedBeamSequenceInRTFractionSchemeModule::Item::getBeamMeterset	(	OFString &	value,
		const signed long	pos = 0
	)		const

get BeamMeterset (300a,0086)

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

get BeamMeterset (300a,0086)

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

get ReferencedBeamNumber (300c,0006)

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

get ReferencedBeamNumber (300c,0006)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTReferencedBeamSequenceInRTFractionSchemeModule::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTReferencedBeamSequenceInRTFractionSchemeModule::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set BeamDose (300a,0084)

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

set BeamDosePointDepth (300a,0088)

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

set BeamDosePointEquivalentDepth (300a,0089)

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

set BeamDosePointSSD (300a,008a)

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

set BeamDoseSpecificationPoint (300a,0082)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTReferencedBeamSequenceInRTFractionSchemeModule::Item::setBeamMeterset	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set BeamMeterset (300a,0086)

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

set ReferencedBeamNumber (300c,0006)

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 DRTReferencedBeamSequenceInRTFractionSchemeModule::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/drtrbs8.h