DRTReferencedBeamSequenceInRTDoseModule::Item Class Reference

Item class. More...

Inheritance diagram for DRTReferencedBeamSequenceInRTDoseModule::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	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...
DRTReferencedControlPointSequence &	getReferencedControlPointSequence ()
	get ReferencedControlPointSequence (300c,00f2) More...
const DRTReferencedControlPointSequence &	getReferencedControlPointSequence () const
	get ReferencedControlPointSequence (300c,00f2) 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
DcmIntegerString	ReferencedBeamNumber
	ReferencedBeamNumber (300c,0006) vr=IS, vm=1, type=1.
DRTReferencedControlPointSequence	ReferencedControlPointSequence
	ReferencedControlPointSequence (300c,00f2) vr=SQ, 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

DRTReferencedBeamSequenceInRTDoseModule::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters

emptyDefaultItem

flag used to mark the empty default item

DRTReferencedBeamSequenceInRTDoseModule::Item::Item

(

const Item &

copy

)

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

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

DRTReferencedControlPointSequence& DRTReferencedBeamSequenceInRTDoseModule::Item::getReferencedControlPointSequence ( )

inline

get ReferencedControlPointSequence (300c,00f2)

Returns

reference to sequence element

const DRTReferencedControlPointSequence& DRTReferencedBeamSequenceInRTDoseModule::Item::getReferencedControlPointSequence ( ) const

inline

get ReferencedControlPointSequence (300c,00f2)

Returns

const reference to sequence element

OFBool DRTReferencedBeamSequenceInRTDoseModule::Item::isEmpty

(

)

check if item is empty

Returns

OFTrue if item is empty, OFFalse otherwise

OFBool DRTReferencedBeamSequenceInRTDoseModule::Item::isValid

(

)

const

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

Returns

OFTrue if item is valid, OFFalse otherwise

Item& DRTReferencedBeamSequenceInRTDoseModule::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters

copy	item object to be copied

Returns

reference to this object

OFCondition DRTReferencedBeamSequenceInRTDoseModule::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 DRTReferencedBeamSequenceInRTDoseModule::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 DRTReferencedBeamSequenceInRTDoseModule::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/drtrbs2.h