DRTFrameOfReferenceRelationshipSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTFrameOfReferenceRelationshipSequence::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	getFrameOfReferenceTransformationComment (OFString &value, const signed long pos=0) const
	get FrameOfReferenceTransformationComment (3006,00c8)
OFCondition	getFrameOfReferenceTransformationMatrix (OFString &value, const signed long pos=0) const
	get FrameOfReferenceTransformationMatrix (3006,00c6)
OFCondition	getFrameOfReferenceTransformationMatrix (Float64 &value, const unsigned long pos=0) const
	get FrameOfReferenceTransformationMatrix (3006,00c6)
OFCondition	getFrameOfReferenceTransformationMatrix (OFVector< Float64 > &value) const
	get FrameOfReferenceTransformationMatrix (3006,00c6)
OFCondition	getFrameOfReferenceTransformationType (OFString &value, const signed long pos=0) const
	get FrameOfReferenceTransformationType (3006,00c4)
OFCondition	getRelatedFrameOfReferenceUID (OFString &value, const signed long pos=0) const
	get RelatedFrameOfReferenceUID (3006,00c2)
OFCondition	setFrameOfReferenceTransformationComment (const OFString &value, const OFBool check=OFTrue)
	set FrameOfReferenceTransformationComment (3006,00c8)
OFCondition	setFrameOfReferenceTransformationMatrix (const OFString &value, const OFBool check=OFTrue)
	set FrameOfReferenceTransformationMatrix (3006,00c6)
OFCondition	setFrameOfReferenceTransformationType (const OFString &value, const OFBool check=OFTrue)
	set FrameOfReferenceTransformationType (3006,00c4)
OFCondition	setRelatedFrameOfReferenceUID (const OFString &value, const OFBool check=OFTrue)
	set RelatedFrameOfReferenceUID (3006,00c2)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmLongString	FrameOfReferenceTransformationComment
	FrameOfReferenceTransformationComment (3006,00c8) vr=LO, vm=1, type=3.
DcmDecimalString	FrameOfReferenceTransformationMatrix
	FrameOfReferenceTransformationMatrix (3006,00c6) vr=DS, vm=16, type=1C.
DcmCodeString	FrameOfReferenceTransformationType
	FrameOfReferenceTransformationType (3006,00c4) vr=CS, vm=1, type=1C.
DcmUniqueIdentifier	RelatedFrameOfReferenceUID
	RelatedFrameOfReferenceUID (3006,00c2) vr=UI, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTFrameOfReferenceRelationshipSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTFrameOfReferenceRelationshipSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTFrameOfReferenceRelationshipSequence::Item::getFrameOfReferenceTransformationComment	(	OFString &	value,
		const signed long	pos = 0
	)		const

get FrameOfReferenceTransformationComment (3006,00c8)

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

get FrameOfReferenceTransformationMatrix (3006,00c6)

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

get FrameOfReferenceTransformationMatrix (3006,00c6)

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 DRTFrameOfReferenceRelationshipSequence::Item::getFrameOfReferenceTransformationMatrix

(

OFVector< Float64 > &

value

)

const

get FrameOfReferenceTransformationMatrix (3006,00c6)

Parameters:

value

reference to variable in which the value(s) should be stored

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTFrameOfReferenceRelationshipSequence::Item::getFrameOfReferenceTransformationType	(	OFString &	value,
		const signed long	pos = 0
	)		const

get FrameOfReferenceTransformationType (3006,00c4)

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

get RelatedFrameOfReferenceUID (3006,00c2)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTFrameOfReferenceRelationshipSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTFrameOfReferenceRelationshipSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set FrameOfReferenceTransformationComment (3006,00c8)

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

set FrameOfReferenceTransformationMatrix (3006,00c6)

Parameters:

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (16) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTFrameOfReferenceRelationshipSequence::Item::setFrameOfReferenceTransformationType	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set FrameOfReferenceTransformationType (3006,00c4)

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

set RelatedFrameOfReferenceUID (3006,00c2)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTFrameOfReferenceRelationshipSequence::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/drtforrs.h