DRTLateralSpreadingDeviceSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTLateralSpreadingDeviceSequence::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	getLateralSpreadingDeviceDescription (OFString &value, const signed long pos=0) const
	get LateralSpreadingDeviceDescription (300a,033a)
OFCondition	getLateralSpreadingDeviceID (OFString &value, const signed long pos=0) const
	get LateralSpreadingDeviceID (300a,0336)
OFCondition	getLateralSpreadingDeviceNumber (OFString &value, const signed long pos=0) const
	get LateralSpreadingDeviceNumber (300a,0334)
OFCondition	getLateralSpreadingDeviceNumber (Sint32 &value, const unsigned long pos=0) const
	get LateralSpreadingDeviceNumber (300a,0334)
OFCondition	getLateralSpreadingDeviceType (OFString &value, const signed long pos=0) const
	get LateralSpreadingDeviceType (300a,0338)
OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9)
OFCondition	setLateralSpreadingDeviceDescription (const OFString &value, const OFBool check=OFTrue)
	set LateralSpreadingDeviceDescription (300a,033a)
OFCondition	setLateralSpreadingDeviceID (const OFString &value, const OFBool check=OFTrue)
	set LateralSpreadingDeviceID (300a,0336)
OFCondition	setLateralSpreadingDeviceNumber (const OFString &value, const OFBool check=OFTrue)
	set LateralSpreadingDeviceNumber (300a,0334)
OFCondition	setLateralSpreadingDeviceType (const OFString &value, const OFBool check=OFTrue)
	set LateralSpreadingDeviceType (300a,0338)
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	LateralSpreadingDeviceDescription
	LateralSpreadingDeviceDescription (300a,033a) vr=LO, vm=1, type=3.
DcmShortString	LateralSpreadingDeviceID
	LateralSpreadingDeviceID (300a,0336) vr=SH, vm=1, type=1.
DcmIntegerString	LateralSpreadingDeviceNumber
	LateralSpreadingDeviceNumber (300a,0334) vr=IS, vm=1, type=1.
DcmCodeString	LateralSpreadingDeviceType
	LateralSpreadingDeviceType (300a,0338) vr=CS, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTLateralSpreadingDeviceSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTLateralSpreadingDeviceSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

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

get LateralSpreadingDeviceDescription (300a,033a)

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

get LateralSpreadingDeviceID (300a,0336)

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

get LateralSpreadingDeviceNumber (300a,0334)

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

get LateralSpreadingDeviceNumber (300a,0334)

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

get LateralSpreadingDeviceType (300a,0338)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTLateralSpreadingDeviceSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTLateralSpreadingDeviceSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set LateralSpreadingDeviceDescription (300a,033a)

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

set LateralSpreadingDeviceID (300a,0336)

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

set LateralSpreadingDeviceNumber (300a,0334)

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

set LateralSpreadingDeviceType (300a,0338)

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 DRTLateralSpreadingDeviceSequence::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/drtlsds.h