DRTReferencedSetupImageSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTReferencedSetupImageSequence::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	getReferencedFrameNumber (OFString &value, const signed long pos=0) const
	get ReferencedFrameNumber (0008,1160)
OFCondition	getReferencedFrameNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedFrameNumber (0008,1160)
OFCondition	getReferencedSOPClassUID (OFString &value, const signed long pos=0) const
	get ReferencedSOPClassUID (0008,1150)
OFCondition	getReferencedSOPInstanceUID (OFString &value, const signed long pos=0) const
	get ReferencedSOPInstanceUID (0008,1155)
OFCondition	getReferencedSegmentNumber (Uint16 &value, const unsigned long pos=0) const
	get ReferencedSegmentNumber (0062,000b)
OFCondition	getSetupImageComment (OFString &value, const signed long pos=0) const
	get SetupImageComment (300a,0402)
OFCondition	setReferencedFrameNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedFrameNumber (0008,1160)
OFCondition	setReferencedSOPClassUID (const OFString &value, const OFBool check=OFTrue)
	set ReferencedSOPClassUID (0008,1150)
OFCondition	setReferencedSOPInstanceUID (const OFString &value, const OFBool check=OFTrue)
	set ReferencedSOPInstanceUID (0008,1155)
OFCondition	setReferencedSegmentNumber (const Uint16 value, const unsigned long pos=0)
	set ReferencedSegmentNumber (0062,000b)
OFCondition	setSetupImageComment (const OFString &value, const OFBool check=OFTrue)
	set SetupImageComment (300a,0402)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmIntegerString	ReferencedFrameNumber
	ReferencedFrameNumber (0008,1160) vr=IS, vm=1-n, type=1C.
DcmUniqueIdentifier	ReferencedSOPClassUID
	ReferencedSOPClassUID (0008,1150) vr=UI, vm=1, type=1.
DcmUniqueIdentifier	ReferencedSOPInstanceUID
	ReferencedSOPInstanceUID (0008,1155) vr=UI, vm=1, type=1.
DcmUnsignedShort	ReferencedSegmentNumber
	ReferencedSegmentNumber (0062,000b) vr=US, vm=1-n, type=1C.
DcmShortText	SetupImageComment
	SetupImageComment (300a,0402) vr=ST, vm=1, type=3.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTReferencedSetupImageSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTReferencedSetupImageSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTReferencedSetupImageSequence::Item::getReferencedFrameNumber	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ReferencedFrameNumber (0008,1160)

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

get ReferencedFrameNumber (0008,1160)

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 DRTReferencedSetupImageSequence::Item::getReferencedSegmentNumber	(	Uint16 &	value,
		const unsigned long	pos = 0
	)		const

get ReferencedSegmentNumber (0062,000b)

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

get ReferencedSOPClassUID (0008,1150)

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

get ReferencedSOPInstanceUID (0008,1155)

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

get SetupImageComment (300a,0402)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTReferencedSetupImageSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTReferencedSetupImageSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set ReferencedFrameNumber (0008,1160)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTReferencedSetupImageSequence::Item::setReferencedSegmentNumber	(	const Uint16	value,
		const unsigned long	pos = 0
	)

set ReferencedSegmentNumber (0062,000b)

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-n

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTReferencedSetupImageSequence::Item::setReferencedSOPClassUID	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ReferencedSOPClassUID (0008,1150)

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

set ReferencedSOPInstanceUID (0008,1155)

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

set SetupImageComment (300a,0402)

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 DRTReferencedSetupImageSequence::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/drtrsis.h