DRTReferencedImageSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTReferencedImageSequence::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	getCodeMeaning (OFString &value, const signed long pos=0) const
	get CodeMeaning (0008,0104)
OFCondition	getCodeValue (OFString &value, const signed long pos=0) const
	get CodeValue (0008,0100)
OFCondition	getCodingSchemeDesignator (OFString &value, const signed long pos=0) const
	get CodingSchemeDesignator (0008,0102)
OFCondition	getCodingSchemeVersion (OFString &value, const signed long pos=0) const
	get CodingSchemeVersion (0008,0103)
OFCondition	getContextGroupExtensionCreatorUID (OFString &value, const signed long pos=0) const
	get ContextGroupExtensionCreatorUID (0008,010d)
OFCondition	getContextGroupExtensionFlag (OFString &value, const signed long pos=0) const
	get ContextGroupExtensionFlag (0008,010b)
OFCondition	getContextGroupLocalVersion (OFString &value, const signed long pos=0) const
	get ContextGroupLocalVersion (0008,0107)
OFCondition	getContextGroupVersion (OFString &value, const signed long pos=0) const
	get ContextGroupVersion (0008,0106)
OFCondition	getContextIdentifier (OFString &value, const signed long pos=0) const
	get ContextIdentifier (0008,010f)
OFCondition	getMappingResource (OFString &value, const signed long pos=0) const
	get MappingResource (0008,0105)
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)
DRTPurposeOfReferenceCodeSequence &	getPurposeOfReferenceCodeSequence ()
	get PurposeOfReferenceCodeSequence (0040,a170)
const DRTPurposeOfReferenceCodeSequence &	getPurposeOfReferenceCodeSequence () const
	get PurposeOfReferenceCodeSequence (0040,a170)
OFCondition	setCodeMeaning (const OFString &value, const OFBool check=OFTrue)
	set CodeMeaning (0008,0104)
OFCondition	setCodeValue (const OFString &value, const OFBool check=OFTrue)
	set CodeValue (0008,0100)
OFCondition	setCodingSchemeDesignator (const OFString &value, const OFBool check=OFTrue)
	set CodingSchemeDesignator (0008,0102)
OFCondition	setCodingSchemeVersion (const OFString &value, const OFBool check=OFTrue)
	set CodingSchemeVersion (0008,0103)
OFCondition	setContextGroupExtensionCreatorUID (const OFString &value, const OFBool check=OFTrue)
	set ContextGroupExtensionCreatorUID (0008,010d)
OFCondition	setContextGroupExtensionFlag (const OFString &value, const OFBool check=OFTrue)
	set ContextGroupExtensionFlag (0008,010b)
OFCondition	setContextGroupLocalVersion (const OFString &value, const OFBool check=OFTrue)
	set ContextGroupLocalVersion (0008,0107)
OFCondition	setContextGroupVersion (const OFString &value, const OFBool check=OFTrue)
	set ContextGroupVersion (0008,0106)
OFCondition	setContextIdentifier (const OFString &value, const OFBool check=OFTrue)
	set ContextIdentifier (0008,010f)
OFCondition	setMappingResource (const OFString &value, const OFBool check=OFTrue)
	set MappingResource (0008,0105)
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)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmLongString	CodeMeaning
	CodeMeaning (0008,0104) vr=LO, vm=1, type=1C.
DcmShortString	CodeValue
	CodeValue (0008,0100) vr=SH, vm=1, type=1C.
DcmShortString	CodingSchemeDesignator
	CodingSchemeDesignator (0008,0102) vr=SH, vm=1, type=1C.
DcmShortString	CodingSchemeVersion
	CodingSchemeVersion (0008,0103) vr=SH, vm=1, type=1C.
DcmUniqueIdentifier	ContextGroupExtensionCreatorUID
	ContextGroupExtensionCreatorUID (0008,010d) vr=UI, vm=1, type=1C.
DcmCodeString	ContextGroupExtensionFlag
	ContextGroupExtensionFlag (0008,010b) vr=CS, vm=1, type=3.
DcmDateTime	ContextGroupLocalVersion
	ContextGroupLocalVersion (0008,0107) vr=DT, vm=1, type=1C.
DcmDateTime	ContextGroupVersion
	ContextGroupVersion (0008,0106) vr=DT, vm=1, type=1C.
DcmCodeString	ContextIdentifier
	ContextIdentifier (0008,010f) vr=CS, vm=1, type=3.
DcmCodeString	MappingResource
	MappingResource (0008,0105) vr=CS, vm=1, type=1C.
DRTPurposeOfReferenceCodeSequence	PurposeOfReferenceCodeSequence
	PurposeOfReferenceCodeSequence (0040,a170) vr=SQ, vm=1, type=3.
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.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTReferencedImageSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTReferencedImageSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTReferencedImageSequence::Item::getCodeMeaning	(	OFString &	value,
		const signed long	pos = 0
	)		const

get CodeMeaning (0008,0104)

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

get CodeValue (0008,0100)

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

get CodingSchemeDesignator (0008,0102)

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

get CodingSchemeVersion (0008,0103)

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

get ContextGroupExtensionCreatorUID (0008,010d)

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

get ContextGroupExtensionFlag (0008,010b)

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

get ContextGroupLocalVersion (0008,0107)

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

get ContextGroupVersion (0008,0106)

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

get ContextIdentifier (0008,010f)

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

get MappingResource (0008,0105)

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

DRTPurposeOfReferenceCodeSequence& DRTReferencedImageSequence::Item::getPurposeOfReferenceCodeSequence

(

)

[inline]

get PurposeOfReferenceCodeSequence (0040,a170)

Returns:

reference to sequence element

const DRTPurposeOfReferenceCodeSequence& DRTReferencedImageSequence::Item::getPurposeOfReferenceCodeSequence

(

)

const [inline]

get PurposeOfReferenceCodeSequence (0040,a170)

Returns:

const reference to sequence element

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

OFBool DRTReferencedImageSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTReferencedImageSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTReferencedImageSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set CodeMeaning (0008,0104)

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

set CodeValue (0008,0100)

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

set CodingSchemeDesignator (0008,0102)

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

set CodingSchemeVersion (0008,0103)

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

set ContextGroupExtensionCreatorUID (0008,010d)

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

set ContextGroupExtensionFlag (0008,010b)

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

set ContextGroupLocalVersion (0008,0107)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTReferencedImageSequence::Item::setContextGroupVersion	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ContextGroupVersion (0008,0106)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTReferencedImageSequence::Item::setContextIdentifier	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ContextIdentifier (0008,010f)

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

set MappingResource (0008,0105)

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 DRTReferencedImageSequence::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 DRTReferencedImageSequence::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 DRTReferencedImageSequence::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 DRTReferencedImageSequence::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 DRTReferencedImageSequence::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/drtrims.h