Inheritance diagram for DRTFixationDeviceSequence::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	getFixationDeviceDescription (OFString &value, const signed long pos=0) const
	get FixationDeviceDescription (300a,0196) More...

OFCondition	getFixationDeviceLabel (OFString &value, const signed long pos=0) const
	get FixationDeviceLabel (300a,0194) More...

OFCondition	getFixationDevicePitchAngle (Float32 &value, const unsigned long pos=0) const
	get FixationDevicePitchAngle (300a,0199) More...

OFCondition	getFixationDevicePosition (OFString &value, const signed long pos=0) const
	get FixationDevicePosition (300a,0198) More...

OFCondition	getFixationDeviceRollAngle (Float32 &value, const unsigned long pos=0) const
	get FixationDeviceRollAngle (300a,019a) More...

OFCondition	getFixationDeviceType (OFString &value, const signed long pos=0) const
	get FixationDeviceType (300a,0192) More...

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

OFCondition	setFixationDeviceDescription (const OFString &value, const OFBool check=OFTrue)
	set FixationDeviceDescription (300a,0196) More...

OFCondition	setFixationDeviceLabel (const OFString &value, const OFBool check=OFTrue)
	set FixationDeviceLabel (300a,0194) More...

OFCondition	setFixationDevicePitchAngle (const Float32 value, const unsigned long pos=0)
	set FixationDevicePitchAngle (300a,0199) More...

OFCondition	setFixationDevicePosition (const OFString &value, const OFBool check=OFTrue)
	set FixationDevicePosition (300a,0198) More...

OFCondition	setFixationDeviceRollAngle (const Float32 value, const unsigned long pos=0)
	set FixationDeviceRollAngle (300a,019a) More...

OFCondition	setFixationDeviceType (const OFString &value, const OFBool check=OFTrue)
	set FixationDeviceType (300a,0192) 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	FixationDeviceDescription
	FixationDeviceDescription (300a,0196) vr=ST, vm=1, type=3.

DcmShortString	FixationDeviceLabel
	FixationDeviceLabel (300a,0194) vr=SH, vm=1, type=2.

DcmFloatingPointSingle	FixationDevicePitchAngle
	FixationDevicePitchAngle (300a,0199) vr=FL, vm=1, type=3.

DcmShortString	FixationDevicePosition
	FixationDevicePosition (300a,0198) vr=SH, vm=1, type=3.

DcmFloatingPointSingle	FixationDeviceRollAngle
	FixationDeviceRollAngle (300a,019a) vr=FL, vm=1, type=3.

DcmCodeString	FixationDeviceType
	FixationDeviceType (300a,0192) 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

◆ Item() [1/2]

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

◆ Item() [2/2]

DRTFixationDeviceSequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

◆ getAccessoryCode()

OFCondition DRTFixationDeviceSequence::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

◆ getFixationDeviceDescription()

OFCondition DRTFixationDeviceSequence::Item::getFixationDeviceDescription	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get FixationDeviceDescription (300a,0196)

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

◆ getFixationDeviceLabel()

OFCondition DRTFixationDeviceSequence::Item::getFixationDeviceLabel	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get FixationDeviceLabel (300a,0194)

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

◆ getFixationDevicePitchAngle()

OFCondition DRTFixationDeviceSequence::Item::getFixationDevicePitchAngle	(	Float32 &	value,
		const unsigned long	pos = `0`
	)		const

get FixationDevicePitchAngle (300a,0199)

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

◆ getFixationDevicePosition()

OFCondition DRTFixationDeviceSequence::Item::getFixationDevicePosition	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get FixationDevicePosition (300a,0198)

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

◆ getFixationDeviceRollAngle()

OFCondition DRTFixationDeviceSequence::Item::getFixationDeviceRollAngle	(	Float32 &	value,
		const unsigned long	pos = `0`
	)		const

get FixationDeviceRollAngle (300a,019a)

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

◆ getFixationDeviceType()

OFCondition DRTFixationDeviceSequence::Item::getFixationDeviceType	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get FixationDeviceType (300a,0192)

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

◆ isEmpty()

OFBool DRTFixationDeviceSequence::Item::isEmpty ( )

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTFixationDeviceSequence::Item::isValid ( ) const

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

Returns: OFTrue if item is valid, OFFalse otherwise

◆ operator=()

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

assigment operator

Parameters

copy	item object to be copied

Returns: reference to this object

◆ read()

OFCondition DRTFixationDeviceSequence::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

◆ setAccessoryCode()

OFCondition DRTFixationDeviceSequence::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

◆ setFixationDeviceDescription()

OFCondition DRTFixationDeviceSequence::Item::setFixationDeviceDescription	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set FixationDeviceDescription (300a,0196)

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

◆ setFixationDeviceLabel()

OFCondition DRTFixationDeviceSequence::Item::setFixationDeviceLabel	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set FixationDeviceLabel (300a,0194)

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

◆ setFixationDevicePitchAngle()

OFCondition DRTFixationDeviceSequence::Item::setFixationDevicePitchAngle	(	const Float32	value,
		const unsigned long	pos = `0`
	)

set FixationDevicePitchAngle (300a,0199)

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

◆ setFixationDevicePosition()

OFCondition DRTFixationDeviceSequence::Item::setFixationDevicePosition	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set FixationDevicePosition (300a,0198)

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

◆ setFixationDeviceRollAngle()

OFCondition DRTFixationDeviceSequence::Item::setFixationDeviceRollAngle	(	const Float32	value,
		const unsigned long	pos = `0`
	)

set FixationDeviceRollAngle (300a,019a)

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

◆ setFixationDeviceType()

OFCondition DRTFixationDeviceSequence::Item::setFixationDeviceType	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set FixationDeviceType (300a,0192)

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

◆ write()

OFCondition DRTFixationDeviceSequence::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/drtfds.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Item() [1/2]

◆ Item() [2/2]

Member Function Documentation

◆ getAccessoryCode()

◆ getFixationDeviceDescription()

◆ getFixationDeviceLabel()

◆ getFixationDevicePitchAngle()

◆ getFixationDevicePosition()

◆ getFixationDeviceRollAngle()

◆ getFixationDeviceType()

◆ isEmpty()

◆ isValid()

◆ operator=()

◆ read()

◆ setAccessoryCode()

◆ setFixationDeviceDescription()

◆ setFixationDeviceLabel()

◆ setFixationDevicePitchAngle()

◆ setFixationDevicePosition()

◆ setFixationDeviceRollAngle()

◆ setFixationDeviceType()

◆ write()