Inheritance diagram for DRTIonWedgeSequence::Item:

Public Member Functions
	Item (const OFBool emptyDefaultItem=OFFalse)
	(default) constructor More...

	Item (const Item &copy)
	copy constructor More...

virtual	~Item ()
	destructor

Item &	operator= (const Item &copy)
	assigment operator More...

void	clear ()
	clear all internal member variables

OFBool	isEmpty ()
	check if item is empty More...

OFBool	isValid () const
	check if item is valid, i.e. not the empty default item More...

OFCondition	read (DcmItem &item)
	read elements from sequence item More...

OFCondition	write (DcmItem &item)
	write elements to sequence item More...

OFCondition	getAccessoryCode (OFString &value, const signed long pos=0) const
	get AccessoryCode (300a,00f9) More...

OFCondition	getIsocenterToWedgeTrayDistance (Float32 &value, const unsigned long pos=0) const
	get IsocenterToWedgeTrayDistance (300a,00d9) More...

OFCondition	getWedgeAngle (OFString &value, const signed long pos=0) const
	get WedgeAngle (300a,00d5) More...

OFCondition	getWedgeAngle (Sint32 &value, const unsigned long pos=0) const
	get WedgeAngle (300a,00d5) More...

OFCondition	getWedgeID (OFString &value, const signed long pos=0) const
	get WedgeID (300a,00d4) More...

OFCondition	getWedgeNumber (OFString &value, const signed long pos=0) const
	get WedgeNumber (300a,00d2) More...

OFCondition	getWedgeNumber (Sint32 &value, const unsigned long pos=0) const
	get WedgeNumber (300a,00d2) More...

OFCondition	getWedgeOrientation (OFString &value, const signed long pos=0) const
	get WedgeOrientation (300a,00d8) More...

OFCondition	getWedgeOrientation (Float64 &value, const unsigned long pos=0) const
	get WedgeOrientation (300a,00d8) More...

OFCondition	getWedgeType (OFString &value, const signed long pos=0) const
	get WedgeType (300a,00d3) More...

OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9) More...

OFCondition	setIsocenterToWedgeTrayDistance (const Float32 value, const unsigned long pos=0)
	set IsocenterToWedgeTrayDistance (300a,00d9) More...

OFCondition	setWedgeAngle (const OFString &value, const OFBool check=OFTrue)
	set WedgeAngle (300a,00d5) More...

OFCondition	setWedgeID (const OFString &value, const OFBool check=OFTrue)
	set WedgeID (300a,00d4) More...

OFCondition	setWedgeNumber (const OFString &value, const OFBool check=OFTrue)
	set WedgeNumber (300a,00d2) More...

OFCondition	setWedgeOrientation (const OFString &value, const OFBool check=OFTrue)
	set WedgeOrientation (300a,00d8) More...

OFCondition	setWedgeType (const OFString &value, const OFBool check=OFTrue)
	set WedgeType (300a,00d3) More...

Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item

DcmLongString	AccessoryCode
	AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.

DcmFloatingPointSingle	IsocenterToWedgeTrayDistance
	IsocenterToWedgeTrayDistance (300a,00d9) vr=FL, vm=1, type=1.

DcmIntegerString	WedgeAngle
	WedgeAngle (300a,00d5) vr=IS, vm=1, type=2.

DcmShortString	WedgeID
	WedgeID (300a,00d4) vr=SH, vm=1, type=3.

DcmIntegerString	WedgeNumber
	WedgeNumber (300a,00d2) vr=IS, vm=1, type=1.

DcmDecimalString	WedgeOrientation
	WedgeOrientation (300a,00d8) vr=DS, vm=1, type=2.

DcmCodeString	WedgeType
	WedgeType (300a,00d3) vr=CS, vm=1, type=2.

Additional Inherited Members
Protected Member Functions inherited from DRTTypes
virtual	~DRTTypes ()
	destructor. More...

Static Protected Member Functions inherited from DRTTypes
static OFCondition	addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement element, const OFString &vm, const OFString &type, const char moduleName=NULL)
	add given element to the dataset. More...

static OFCondition	getElementFromDataset (DcmItem &dataset, DcmElement &element)
	get element from dataset More...

static OFCondition	getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0)
	get string value from element More...

static OFCondition	getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
	get string value from dataset More...

static OFCondition	putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
	put string value to dataset More...

static OFBool	checkElementValue (DcmElement &element, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL)
	check element value for correct value multiplicity and type More...

static OFCondition	getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
	get element from dataset and check it for correct value multiplicity and type. More...

static OFCondition	getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, const char *moduleName=NULL)
	get string value from dataset and check it for correct value multiplicity and type. More...

Detailed Description

Item class.

Constructor & Destructor Documentation

DRTIonWedgeSequence::Item::Item ( const OFBool emptyDefaultItem = OFFalse )

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

DRTIonWedgeSequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

OFCondition DRTIonWedgeSequence::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 DRTIonWedgeSequence::Item::getIsocenterToWedgeTrayDistance	(	Float32 &	value,
		const unsigned long	pos = `0`
	)		const

get IsocenterToWedgeTrayDistance (300a,00d9)

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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::Item::isEmpty ( )

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

OFBool DRTIonWedgeSequence::Item::isValid ( ) const

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

Returns: OFTrue if item is valid, OFFalse otherwise

Item& DRTIonWedgeSequence::Item::operator= ( const Item & copy )

assigment operator

Parameters

copy	item object to be copied

Returns: reference to this object

OFCondition DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::Item::setIsocenterToWedgeTrayDistance	(	const Float32	value,
		const unsigned long	pos = `0`
	)

set IsocenterToWedgeTrayDistance (300a,00d9)

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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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 DRTIonWedgeSequence::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/drtiws.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation