Item class. More...

Inheritance diagram for DRTReferencedImageSequence::Item:

Public Member Functions
	Item (const OFBool emptyDefaultItem=OFFalse)
	(default) constructor
	Item (const Item &copy)
	copy constructor
virtual	~Item ()
	destructor
Item &	operator= (const Item &copy)
	assignment 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)
DRTPurposeOfReferenceCodeSequence &	getPurposeOfReferenceCodeSequence ()
	get PurposeOfReferenceCodeSequence (0040,a170)
const DRTPurposeOfReferenceCodeSequence &	getPurposeOfReferenceCodeSequence () const
	get PurposeOfReferenceCodeSequence (0040,a170)
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
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.

Additional Inherited Members
Protected Member Functions inherited from DRTTypes
virtual	~DRTTypes ()
	destructor.
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.
static OFCondition	getElementFromDataset (DcmItem &dataset, DcmElement &element)
	get element from dataset
static OFCondition	getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0)
	get string value from element
static OFCondition	getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
	get string value from dataset
static OFCondition	putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
	put string value to dataset
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
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.
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.

Detailed Description

Item class.

Constructor & Destructor Documentation

◆ Item() [1/2]

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

Referenced by Item(), and operator=().

◆ Item() [2/2]

DRTReferencedImageSequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

References Item().

Member Function Documentation

◆ getPurposeOfReferenceCodeSequence() [1/2]

DRTPurposeOfReferenceCodeSequence & DRTReferencedImageSequence::Item::getPurposeOfReferenceCodeSequence ( )

inline

get PurposeOfReferenceCodeSequence (0040,a170)

Returns: reference to sequence element

References PurposeOfReferenceCodeSequence.

◆ getPurposeOfReferenceCodeSequence() [2/2]

const DRTPurposeOfReferenceCodeSequence & DRTReferencedImageSequence::Item::getPurposeOfReferenceCodeSequence ( ) const

inline

get PurposeOfReferenceCodeSequence (0040,a170)

Returns: const reference to sequence element

References PurposeOfReferenceCodeSequence.

◆ getReferencedFrameNumber() [1/2]

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

◆ getReferencedFrameNumber() [2/2]

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

◆ getReferencedSegmentNumber()

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

◆ getReferencedSOPClassUID()

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

◆ getReferencedSOPInstanceUID()

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

◆ isEmpty()

OFBool DRTReferencedImageSequence::Item::isEmpty ( )

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

◆ isValid()

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

◆ operator=()

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

assignment operator

Parameters

copy	item object to be copied

Returns: reference to this object

References Item().

◆ read()

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

◆ setReferencedFrameNumber()

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

◆ setReferencedSegmentNumber()

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

◆ setReferencedSOPClassUID()

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

◆ setReferencedSOPInstanceUID()

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

◆ write()

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Item() [1/2]

◆ Item() [2/2]

Member Function Documentation

◆ getPurposeOfReferenceCodeSequence() [1/2]

◆ getPurposeOfReferenceCodeSequence() [2/2]

◆ getReferencedFrameNumber() [1/2]

◆ getReferencedFrameNumber() [2/2]

◆ getReferencedSegmentNumber()

◆ getReferencedSOPClassUID()

◆ getReferencedSOPInstanceUID()

◆ isEmpty()

◆ isValid()

◆ operator=()

◆ read()

◆ setReferencedFrameNumber()

◆ setReferencedSegmentNumber()

◆ setReferencedSOPClassUID()

◆ setReferencedSOPInstanceUID()

◆ write()