DRTReferencedBeamSequenceInRTFractionSchemeModule::Item Class Reference

Item class. More...

Inheritance diagram for DRTReferencedBeamSequenceInRTFractionSchemeModule::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	getAlternateBeamDose (OFString &value, const signed long pos=0) const
	get AlternateBeamDose (300a,0091) More...
OFCondition	getAlternateBeamDose (Float64 &value, const unsigned long pos=0) const
	get AlternateBeamDose (300a,0091) More...
OFCondition	getAlternateBeamDoseType (OFString &value, const signed long pos=0) const
	get AlternateBeamDoseType (300a,0092) More...
OFCondition	getBeamDeliveryDurationLimit (Float64 &value, const unsigned long pos=0) const
	get BeamDeliveryDurationLimit (300a,00c5) More...
OFCondition	getBeamDose (OFString &value, const signed long pos=0) const
	get BeamDose (300a,0084) More...
OFCondition	getBeamDose (Float64 &value, const unsigned long pos=0) const
	get BeamDose (300a,0084) More...
OFCondition	getBeamDoseSpecificationPoint (OFString &value, const signed long pos=0) const
	get BeamDoseSpecificationPoint (300a,0082) More...
OFCondition	getBeamDoseSpecificationPoint (Float64 &value, const unsigned long pos=0) const
	get BeamDoseSpecificationPoint (300a,0082) More...
OFCondition	getBeamDoseSpecificationPoint (OFVector< Float64 > &value) const
	get BeamDoseSpecificationPoint (300a,0082) More...
OFCondition	getBeamDoseType (OFString &value, const signed long pos=0) const
	get BeamDoseType (300a,0090) More...
OFCondition	getBeamMeterset (OFString &value, const signed long pos=0) const
	get BeamMeterset (300a,0086) More...
OFCondition	getBeamMeterset (Float64 &value, const unsigned long pos=0) const
	get BeamMeterset (300a,0086) More...
OFCondition	getReferencedBeamNumber (OFString &value, const signed long pos=0) const
	get ReferencedBeamNumber (300c,0006) More...
OFCondition	getReferencedBeamNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedBeamNumber (300c,0006) More...
DRTBeamDoseVerificationControlPointSequence &	getBeamDoseVerificationControlPointSequence ()
	get BeamDoseVerificationControlPointSequence (300a,008c) More...
const DRTBeamDoseVerificationControlPointSequence &	getBeamDoseVerificationControlPointSequence () const
	get BeamDoseVerificationControlPointSequence (300a,008c) More...
OFCondition	setAlternateBeamDose (const OFString &value, const OFBool check=OFTrue)
	set AlternateBeamDose (300a,0091) More...
OFCondition	setAlternateBeamDoseType (const OFString &value, const OFBool check=OFTrue)
	set AlternateBeamDoseType (300a,0092) More...
OFCondition	setBeamDeliveryDurationLimit (const Float64 value, const unsigned long pos=0)
	set BeamDeliveryDurationLimit (300a,00c5) More...
OFCondition	setBeamDose (const OFString &value, const OFBool check=OFTrue)
	set BeamDose (300a,0084) More...
OFCondition	setBeamDoseSpecificationPoint (const OFString &value, const OFBool check=OFTrue)
	set BeamDoseSpecificationPoint (300a,0082) More...
OFCondition	setBeamDoseType (const OFString &value, const OFBool check=OFTrue)
	set BeamDoseType (300a,0090) More...
OFCondition	setBeamMeterset (const OFString &value, const OFBool check=OFTrue)
	set BeamMeterset (300a,0086) More...
OFCondition	setReferencedBeamNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedBeamNumber (300c,0006) More...

Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmDecimalString	AlternateBeamDose
	AlternateBeamDose (300a,0091) vr=DS, vm=1, type=3.
DcmCodeString	AlternateBeamDoseType
	AlternateBeamDoseType (300a,0092) vr=CS, vm=1, type=1C.
DcmFloatingPointDouble	BeamDeliveryDurationLimit
	BeamDeliveryDurationLimit (300a,00c5) vr=FD, vm=1, type=3.
DcmDecimalString	BeamDose
	BeamDose (300a,0084) vr=DS, vm=1, type=3.
DcmDecimalString	BeamDoseSpecificationPoint
	BeamDoseSpecificationPoint (300a,0082) vr=DS, vm=3, type=3.
DcmCodeString	BeamDoseType
	BeamDoseType (300a,0090) vr=CS, vm=1, type=1C.
DRTBeamDoseVerificationControlPointSequence	BeamDoseVerificationControlPointSequence
	BeamDoseVerificationControlPointSequence (300a,008c) vr=SQ, vm=1, type=3.
DcmDecimalString	BeamMeterset
	BeamMeterset (300a,0086) vr=DS, vm=1, type=3.
DcmIntegerString	ReferencedBeamNumber
	ReferencedBeamNumber (300c,0006) vr=IS, 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

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

get AlternateBeamDose (300a,0091)

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

get AlternateBeamDose (300a,0091)

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

get AlternateBeamDoseType (300a,0092)

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

get BeamDeliveryDurationLimit (300a,00c5)

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

get BeamDoseType (300a,0090)

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

DRTBeamDoseVerificationControlPointSequence& DRTReferencedBeamSequenceInRTFractionSchemeModule::Item::getBeamDoseVerificationControlPointSequence ( )

inline

get BeamDoseVerificationControlPointSequence (300a,008c)

Returns

reference to sequence element

const DRTBeamDoseVerificationControlPointSequence& DRTReferencedBeamSequenceInRTFractionSchemeModule::Item::getBeamDoseVerificationControlPointSequence ( ) const

inline

get BeamDoseVerificationControlPointSequence (300a,008c)

Returns

const reference to sequence element

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

Returns

reference to this object

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

set AlternateBeamDose (300a,0091)

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

set AlternateBeamDoseType (300a,0092)

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

set BeamDeliveryDurationLimit (300a,00c5)

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

set BeamDoseType (300a,0090)

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 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