Inheritance diagram for DRTRangeModulatorSequence::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	getAccessoryCode (OFString &value, const signed long pos=0) const
	get AccessoryCode (300a,00f9) More...

OFCondition	getBeamCurrentModulationID (OFString &value, const signed long pos=0) const
	get BeamCurrentModulationID (300a,034c) More...

OFCondition	getRangeModulatorDescription (OFString &value, const signed long pos=0) const
	get RangeModulatorDescription (300a,034a) More...

OFCondition	getRangeModulatorID (OFString &value, const signed long pos=0) const
	get RangeModulatorID (300a,0346) More...

OFCondition	getRangeModulatorNumber (OFString &value, const signed long pos=0) const
	get RangeModulatorNumber (300a,0344) More...

OFCondition	getRangeModulatorNumber (Sint32 &value, const unsigned long pos=0) const
	get RangeModulatorNumber (300a,0344) More...

OFCondition	getRangeModulatorType (OFString &value, const signed long pos=0) const
	get RangeModulatorType (300a,0348) More...

OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9) More...

OFCondition	setBeamCurrentModulationID (const OFString &value, const OFBool check=OFTrue)
	set BeamCurrentModulationID (300a,034c) More...

OFCondition	setRangeModulatorDescription (const OFString &value, const OFBool check=OFTrue)
	set RangeModulatorDescription (300a,034a) More...

OFCondition	setRangeModulatorID (const OFString &value, const OFBool check=OFTrue)
	set RangeModulatorID (300a,0346) More...

OFCondition	setRangeModulatorNumber (const OFString &value, const OFBool check=OFTrue)
	set RangeModulatorNumber (300a,0344) More...

OFCondition	setRangeModulatorType (const OFString &value, const OFBool check=OFTrue)
	set RangeModulatorType (300a,0348) More...

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

DcmLongString	AccessoryCode
	AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.

DcmShortString	BeamCurrentModulationID
	BeamCurrentModulationID (300a,034c) vr=SH, vm=1, type=1C.

DcmLongString	RangeModulatorDescription
	RangeModulatorDescription (300a,034a) vr=LO, vm=1, type=3.

DcmShortString	RangeModulatorID
	RangeModulatorID (300a,0346) vr=SH, vm=1, type=1.

DcmIntegerString	RangeModulatorNumber
	RangeModulatorNumber (300a,0344) vr=IS, vm=1, type=1.

DcmCodeString	RangeModulatorType
	RangeModulatorType (300a,0348) vr=CS, 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

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

DRTRangeModulatorSequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

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

get AccessoryCode (300a,00f9)

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

get BeamCurrentModulationID (300a,034c)

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

get RangeModulatorDescription (300a,034a)

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

get RangeModulatorID (300a,0346)

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

get RangeModulatorNumber (300a,0344)

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

get RangeModulatorNumber (300a,0344)

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

get RangeModulatorType (300a,0348)

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

OFBool DRTRangeModulatorSequence::Item::isEmpty ( )

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

OFBool DRTRangeModulatorSequence::Item::isValid ( ) const

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

Returns: OFTrue if item is valid, OFFalse otherwise

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

assigment operator

Parameters

copy	item object to be copied

Returns: reference to this object

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

set AccessoryCode (300a,00f9)

Parameters

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

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

OFCondition DRTRangeModulatorSequence::Item::setBeamCurrentModulationID	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set BeamCurrentModulationID (300a,034c)

Parameters

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

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

OFCondition DRTRangeModulatorSequence::Item::setRangeModulatorDescription	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set RangeModulatorDescription (300a,034a)

Parameters

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

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

OFCondition DRTRangeModulatorSequence::Item::setRangeModulatorID	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set RangeModulatorID (300a,0346)

Parameters

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

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

OFCondition DRTRangeModulatorSequence::Item::setRangeModulatorNumber	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set RangeModulatorNumber (300a,0344)

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

set RangeModulatorType (300a,0348)

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 DRTRangeModulatorSequence::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/drtrms.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation