DRTIonWedgePositionSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTIonWedgePositionSequence::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	getReferencedWedgeNumber (OFString &value, const signed long pos=0) const
	get ReferencedWedgeNumber (300c,00c0)
OFCondition	getReferencedWedgeNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedWedgeNumber (300c,00c0)
OFCondition	getWedgePosition (OFString &value, const signed long pos=0) const
	get WedgePosition (300a,0118)
OFCondition	getWedgeThinEdgePosition (Float32 &value, const unsigned long pos=0) const
	get WedgeThinEdgePosition (300a,00db)
OFCondition	setReferencedWedgeNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedWedgeNumber (300c,00c0)
OFCondition	setWedgePosition (const OFString &value, const OFBool check=OFTrue)
	set WedgePosition (300a,0118)
OFCondition	setWedgeThinEdgePosition (const Float32 value, const unsigned long pos=0)
	set WedgeThinEdgePosition (300a,00db)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmIntegerString	ReferencedWedgeNumber
	ReferencedWedgeNumber (300c,00c0) vr=IS, vm=1, type=1.
DcmCodeString	WedgePosition
	WedgePosition (300a,0118) vr=CS, vm=1, type=1.
DcmFloatingPointSingle	WedgeThinEdgePosition
	WedgeThinEdgePosition (300a,00db) vr=FL, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTIonWedgePositionSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTIonWedgePositionSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTIonWedgePositionSequence::Item::getReferencedWedgeNumber	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ReferencedWedgeNumber (300c,00c0)

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

get ReferencedWedgeNumber (300c,00c0)

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

get WedgePosition (300a,0118)

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 DRTIonWedgePositionSequence::Item::getWedgeThinEdgePosition	(	Float32 &	value,
		const unsigned long	pos = 0
	)		const

get WedgeThinEdgePosition (300a,00db)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTIonWedgePositionSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTIonWedgePositionSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ReferencedWedgeNumber (300c,00c0)

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

set WedgePosition (300a,0118)

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 DRTIonWedgePositionSequence::Item::setWedgeThinEdgePosition	(	const Float32	value,
		const unsigned long	pos = 0
	)

set WedgeThinEdgePosition (300a,00db)

Parameters:

value	value to be set (should be valid for this VR)
pos	index of the value to be set (0..vm-1), vm=1

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTIonWedgePositionSequence::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/drtiwps.h