DRTWedgeSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTWedgeSequence::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	getSourceToWedgeTrayDistance (OFString &value, const signed long pos=0) const
	get SourceToWedgeTrayDistance (300a,00da)
OFCondition	getSourceToWedgeTrayDistance (Float64 &value, const unsigned long pos=0) const
	get SourceToWedgeTrayDistance (300a,00da)
OFCondition	getWedgeAngle (OFString &value, const signed long pos=0) const
	get WedgeAngle (300a,00d5)
OFCondition	getWedgeAngle (Sint32 &value, const unsigned long pos=0) const
	get WedgeAngle (300a,00d5)
OFCondition	getWedgeFactor (OFString &value, const signed long pos=0) const
	get WedgeFactor (300a,00d6)
OFCondition	getWedgeFactor (Float64 &value, const unsigned long pos=0) const
	get WedgeFactor (300a,00d6)
OFCondition	getWedgeID (OFString &value, const signed long pos=0) const
	get WedgeID (300a,00d4)
OFCondition	getWedgeNumber (OFString &value, const signed long pos=0) const
	get WedgeNumber (300a,00d2)
OFCondition	getWedgeNumber (Sint32 &value, const unsigned long pos=0) const
	get WedgeNumber (300a,00d2)
OFCondition	getWedgeOrientation (OFString &value, const signed long pos=0) const
	get WedgeOrientation (300a,00d8)
OFCondition	getWedgeOrientation (Float64 &value, const unsigned long pos=0) const
	get WedgeOrientation (300a,00d8)
OFCondition	getWedgeType (OFString &value, const signed long pos=0) const
	get WedgeType (300a,00d3)
OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9)
OFCondition	setSourceToWedgeTrayDistance (const OFString &value, const OFBool check=OFTrue)
	set SourceToWedgeTrayDistance (300a,00da)
OFCondition	setWedgeAngle (const OFString &value, const OFBool check=OFTrue)
	set WedgeAngle (300a,00d5)
OFCondition	setWedgeFactor (const OFString &value, const OFBool check=OFTrue)
	set WedgeFactor (300a,00d6)
OFCondition	setWedgeID (const OFString &value, const OFBool check=OFTrue)
	set WedgeID (300a,00d4)
OFCondition	setWedgeNumber (const OFString &value, const OFBool check=OFTrue)
	set WedgeNumber (300a,00d2)
OFCondition	setWedgeOrientation (const OFString &value, const OFBool check=OFTrue)
	set WedgeOrientation (300a,00d8)
OFCondition	setWedgeType (const OFString &value, const OFBool check=OFTrue)
	set WedgeType (300a,00d3)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmLongString	AccessoryCode
	AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.
DcmDecimalString	SourceToWedgeTrayDistance
	SourceToWedgeTrayDistance (300a,00da) vr=DS, vm=1, type=3.
DcmIntegerString	WedgeAngle
	WedgeAngle (300a,00d5) vr=IS, vm=1, type=2C.
DcmDecimalString	WedgeFactor
	WedgeFactor (300a,00d6) vr=DS, vm=1, type=2C.
DcmShortString	WedgeID
	WedgeID (300a,00d4) vr=SH, vm=1, type=3.
DcmIntegerString	WedgeNumber
	WedgeNumber (300a,00d2) vr=IS, vm=1, type=1C.
DcmDecimalString	WedgeOrientation
	WedgeOrientation (300a,00d8) vr=DS, vm=1, type=2C.
DcmCodeString	WedgeType
	WedgeType (300a,00d3) vr=CS, vm=1, type=2C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTWedgeSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTWedgeSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

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

get SourceToWedgeTrayDistance (300a,00da)

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 DRTWedgeSequence::Item::getSourceToWedgeTrayDistance	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get SourceToWedgeTrayDistance (300a,00da)

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

get WedgeAngle (300a,00d5)

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

get WedgeAngle (300a,00d5)

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

get WedgeFactor (300a,00d6)

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 DRTWedgeSequence::Item::getWedgeFactor	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get WedgeFactor (300a,00d6)

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

get WedgeID (300a,00d4)

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

get WedgeNumber (300a,00d2)

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

get WedgeNumber (300a,00d2)

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

get WedgeOrientation (300a,00d8)

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 DRTWedgeSequence::Item::getWedgeOrientation	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get WedgeOrientation (300a,00d8)

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

get WedgeType (300a,00d3)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTWedgeSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTWedgeSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set SourceToWedgeTrayDistance (300a,00da)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTWedgeSequence::Item::setWedgeAngle	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set WedgeAngle (300a,00d5)

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

set WedgeFactor (300a,00d6)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTWedgeSequence::Item::setWedgeID	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set WedgeID (300a,00d4)

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

set WedgeNumber (300a,00d2)

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

set WedgeOrientation (300a,00d8)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTWedgeSequence::Item::setWedgeType	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set WedgeType (300a,00d3)

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 DRTWedgeSequence::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/drtws.h