DRTRecordedCompensatorSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTRecordedCompensatorSequence::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	getCompensatorID (OFString &value, const signed long pos=0) const
	get CompensatorID (300a,00e5)
OFCondition	getReferencedCompensatorNumber (OFString &value, const signed long pos=0) const
	get ReferencedCompensatorNumber (300c,00d0)
OFCondition	getReferencedCompensatorNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedCompensatorNumber (300c,00d0)
OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9)
OFCondition	setCompensatorID (const OFString &value, const OFBool check=OFTrue)
	set CompensatorID (300a,00e5)
OFCondition	setReferencedCompensatorNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedCompensatorNumber (300c,00d0)
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	CompensatorID
	CompensatorID (300a,00e5) vr=SH, vm=1, type=3.
DcmIntegerString	ReferencedCompensatorNumber
	ReferencedCompensatorNumber (300c,00d0) vr=IS, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTRecordedCompensatorSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTRecordedCompensatorSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

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

get CompensatorID (300a,00e5)

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

get ReferencedCompensatorNumber (300c,00d0)

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

get ReferencedCompensatorNumber (300c,00d0)

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

OFBool DRTRecordedCompensatorSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTRecordedCompensatorSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTRecordedCompensatorSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set CompensatorID (300a,00e5)

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

set ReferencedCompensatorNumber (300c,00d0)

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 DRTRecordedCompensatorSequence::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/drtrcos.h