Inheritance diagram for DRTShieldingDeviceSequence::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	getShieldingDeviceDescription (OFString &value, const signed long pos=0) const
	get ShieldingDeviceDescription (300a,01a6) More...

OFCondition	getShieldingDeviceLabel (OFString &value, const signed long pos=0) const
	get ShieldingDeviceLabel (300a,01a4) More...

OFCondition	getShieldingDevicePosition (OFString &value, const signed long pos=0) const
	get ShieldingDevicePosition (300a,01a8) More...

OFCondition	getShieldingDeviceType (OFString &value, const signed long pos=0) const
	get ShieldingDeviceType (300a,01a2) More...

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

OFCondition	setShieldingDeviceDescription (const OFString &value, const OFBool check=OFTrue)
	set ShieldingDeviceDescription (300a,01a6) More...

OFCondition	setShieldingDeviceLabel (const OFString &value, const OFBool check=OFTrue)
	set ShieldingDeviceLabel (300a,01a4) More...

OFCondition	setShieldingDevicePosition (const OFString &value, const OFBool check=OFTrue)
	set ShieldingDevicePosition (300a,01a8) More...

OFCondition	setShieldingDeviceType (const OFString &value, const OFBool check=OFTrue)
	set ShieldingDeviceType (300a,01a2) 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.

DcmShortText	ShieldingDeviceDescription
	ShieldingDeviceDescription (300a,01a6) vr=ST, vm=1, type=3.

DcmShortString	ShieldingDeviceLabel
	ShieldingDeviceLabel (300a,01a4) vr=SH, vm=1, type=2.

DcmShortString	ShieldingDevicePosition
	ShieldingDevicePosition (300a,01a8) vr=SH, vm=1, type=3.

DcmCodeString	ShieldingDeviceType
	ShieldingDeviceType (300a,01a2) vr=CS, vm=1, type=1.

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

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

DRTShieldingDeviceSequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

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

get ShieldingDeviceDescription (300a,01a6)

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

get ShieldingDeviceLabel (300a,01a4)

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

get ShieldingDevicePosition (300a,01a8)

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

get ShieldingDeviceType (300a,01a2)

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

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

OFBool DRTShieldingDeviceSequence::Item::isValid ( ) const

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

Returns: OFTrue if item is valid, OFFalse otherwise

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

assigment operator

Parameters

copy	item object to be copied

Returns: reference to this object

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

set ShieldingDeviceDescription (300a,01a6)

Parameters

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

Returns: status, EC_Normal if successful, an error code otherwise

OFCondition DRTShieldingDeviceSequence::Item::setShieldingDeviceLabel	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ShieldingDeviceLabel (300a,01a4)

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

set ShieldingDevicePosition (300a,01a8)

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

set ShieldingDeviceType (300a,01a2)

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 DRTShieldingDeviceSequence::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/drtshds.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation