Inheritance diagram for DRTRTDoseROISequence::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	getDoseUnits (OFString &value, const signed long pos=0) const
	get DoseUnits (3004,0002) More...

OFCondition	getDoseValue (OFString &value, const signed long pos=0) const
	get DoseValue (3004,0012) More...

OFCondition	getDoseValue (Float64 &value, const unsigned long pos=0) const
	get DoseValue (3004,0012) More...

OFCondition	getReferencedROINumber (OFString &value, const signed long pos=0) const
	get ReferencedROINumber (3006,0084) More...

OFCondition	getReferencedROINumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedROINumber (3006,0084) More...

OFCondition	setDoseUnits (const OFString &value, const OFBool check=OFTrue)
	set DoseUnits (3004,0002) More...

OFCondition	setDoseValue (const OFString &value, const OFBool check=OFTrue)
	set DoseValue (3004,0012) More...

OFCondition	setReferencedROINumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedROINumber (3006,0084) More...

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

DcmCodeString	DoseUnits
	DoseUnits (3004,0002) vr=CS, vm=1, type=1.

DcmDecimalString	DoseValue
	DoseValue (3004,0012) vr=DS, vm=1, type=1.

DcmIntegerString	ReferencedROINumber
	ReferencedROINumber (3006,0084) 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

◆ Item() [1/2]

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

◆ Item() [2/2]

DRTRTDoseROISequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

◆ getDoseUnits()

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

get DoseUnits (3004,0002)

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

◆ getDoseValue() [1/2]

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

get DoseValue (3004,0012)

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

◆ getDoseValue() [2/2]

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

get DoseValue (3004,0012)

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

◆ getReferencedROINumber() [1/2]

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

get ReferencedROINumber (3006,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

◆ getReferencedROINumber() [2/2]

OFCondition DRTRTDoseROISequence::Item::getReferencedROINumber	(	Sint32 &	value,
		const unsigned long	pos = `0`
	)		const

get ReferencedROINumber (3006,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

◆ isEmpty()

OFBool DRTRTDoseROISequence::Item::isEmpty ( )

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTRTDoseROISequence::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& DRTRTDoseROISequence::Item::operator= ( const Item & copy )

assigment operator

Parameters

copy	item object to be copied

Returns: reference to this object

◆ read()

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

◆ setDoseUnits()

OFCondition DRTRTDoseROISequence::Item::setDoseUnits	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set DoseUnits (3004,0002)

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

◆ setDoseValue()

OFCondition DRTRTDoseROISequence::Item::setDoseValue	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set DoseValue (3004,0012)

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

◆ setReferencedROINumber()

OFCondition DRTRTDoseROISequence::Item::setReferencedROINumber	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ReferencedROINumber (3006,0084)

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

◆ write()

OFCondition DRTRTDoseROISequence::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/drtrdros.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Item() [1/2]

◆ Item() [2/2]

Member Function Documentation

◆ getDoseUnits()

◆ getDoseValue() [1/2]

◆ getDoseValue() [2/2]

◆ getReferencedROINumber() [1/2]

◆ getReferencedROINumber() [2/2]

◆ isEmpty()

◆ isValid()

◆ operator=()

◆ read()

◆ setDoseUnits()

◆ setDoseValue()

◆ setReferencedROINumber()

◆ write()