DRTRangeShifterSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTRangeShifterSequence::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	getRangeShifterDescription (OFString &value, const signed long pos=0) const
	get RangeShifterDescription (300a,0322)
OFCondition	getRangeShifterID (OFString &value, const signed long pos=0) const
	get RangeShifterID (300a,0318)
OFCondition	getRangeShifterNumber (OFString &value, const signed long pos=0) const
	get RangeShifterNumber (300a,0316)
OFCondition	getRangeShifterNumber (Sint32 &value, const unsigned long pos=0) const
	get RangeShifterNumber (300a,0316)
OFCondition	getRangeShifterType (OFString &value, const signed long pos=0) const
	get RangeShifterType (300a,0320)
OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9)
OFCondition	setRangeShifterDescription (const OFString &value, const OFBool check=OFTrue)
	set RangeShifterDescription (300a,0322)
OFCondition	setRangeShifterID (const OFString &value, const OFBool check=OFTrue)
	set RangeShifterID (300a,0318)
OFCondition	setRangeShifterNumber (const OFString &value, const OFBool check=OFTrue)
	set RangeShifterNumber (300a,0316)
OFCondition	setRangeShifterType (const OFString &value, const OFBool check=OFTrue)
	set RangeShifterType (300a,0320)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmLongString	AccessoryCode
	AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.
DcmLongString	RangeShifterDescription
	RangeShifterDescription (300a,0322) vr=LO, vm=1, type=3.
DcmShortString	RangeShifterID
	RangeShifterID (300a,0318) vr=SH, vm=1, type=1.
DcmIntegerString	RangeShifterNumber
	RangeShifterNumber (300a,0316) vr=IS, vm=1, type=1.
DcmCodeString	RangeShifterType
	RangeShifterType (300a,0320) vr=CS, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTRangeShifterSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTRangeShifterSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

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

get RangeShifterDescription (300a,0322)

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

get RangeShifterID (300a,0318)

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

get RangeShifterNumber (300a,0316)

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

get RangeShifterNumber (300a,0316)

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

get RangeShifterType (300a,0320)

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 DRTRangeShifterSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTRangeShifterSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTRangeShifterSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set RangeShifterDescription (300a,0322)

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

set RangeShifterID (300a,0318)

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

set RangeShifterNumber (300a,0316)

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

set RangeShifterType (300a,0320)

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 DRTRangeShifterSequence::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/drtrshs.h