DRTRangeModulatorSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTRangeModulatorSequence::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	getAccessoryCode (OFString &value, const signed long pos=0) const
	get AccessoryCode (300a,00f9)
OFCondition	getBeamCurrentModulationID (OFString &value, const signed long pos=0) const
	get BeamCurrentModulationID (300a,034c)
OFCondition	getRangeModulatorDescription (OFString &value, const signed long pos=0) const
	get RangeModulatorDescription (300a,034a)
OFCondition	getRangeModulatorID (OFString &value, const signed long pos=0) const
	get RangeModulatorID (300a,0346)
OFCondition	getRangeModulatorNumber (OFString &value, const signed long pos=0) const
	get RangeModulatorNumber (300a,0344)
OFCondition	getRangeModulatorNumber (Sint32 &value, const unsigned long pos=0) const
	get RangeModulatorNumber (300a,0344)
OFCondition	getRangeModulatorType (OFString &value, const signed long pos=0) const
	get RangeModulatorType (300a,0348)
OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9)
OFCondition	setBeamCurrentModulationID (const OFString &value, const OFBool check=OFTrue)
	set BeamCurrentModulationID (300a,034c)
OFCondition	setRangeModulatorDescription (const OFString &value, const OFBool check=OFTrue)
	set RangeModulatorDescription (300a,034a)
OFCondition	setRangeModulatorID (const OFString &value, const OFBool check=OFTrue)
	set RangeModulatorID (300a,0346)
OFCondition	setRangeModulatorNumber (const OFString &value, const OFBool check=OFTrue)
	set RangeModulatorNumber (300a,0344)
OFCondition	setRangeModulatorType (const OFString &value, const OFBool check=OFTrue)
	set RangeModulatorType (300a,0348)
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.

---

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

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