DRTHL7StructuredDocumentReferenceSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTHL7StructuredDocumentReferenceSequence::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	getHL7InstanceIdentifier (OFString &value, const signed long pos=0) const
	get HL7InstanceIdentifier (0040,e001)
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	getRetrieveURI (OFString &value, const signed long pos=0) const
	get RetrieveURI (0040,e010)
OFCondition	setHL7InstanceIdentifier (const OFString &value, const OFBool check=OFTrue)
	set HL7InstanceIdentifier (0040,e001)
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	setRetrieveURI (const OFString &value, const OFBool check=OFTrue)
	set RetrieveURI (0040,e010)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmShortText	HL7InstanceIdentifier
	HL7InstanceIdentifier (0040,e001) vr=ST, vm=1, type=1.
DcmUniqueIdentifier	ReferencedSOPClassUID
	ReferencedSOPClassUID (0008,1150) vr=UI, vm=1, type=1.
DcmUniqueIdentifier	ReferencedSOPInstanceUID
	ReferencedSOPInstanceUID (0008,1155) vr=UI, vm=1, type=1.
DcmUnlimitedText	RetrieveURI
	RetrieveURI (0040,e010) vr=UT, vm=1, type=3.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTHL7StructuredDocumentReferenceSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTHL7StructuredDocumentReferenceSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTHL7StructuredDocumentReferenceSequence::Item::getHL7InstanceIdentifier	(	OFString &	value,
		const signed long	pos = 0
	)		const

get HL7InstanceIdentifier (0040,e001)

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

get RetrieveURI (0040,e010)

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

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTHL7StructuredDocumentReferenceSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTHL7StructuredDocumentReferenceSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set HL7InstanceIdentifier (0040,e001)

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

set RetrieveURI (0040,e010)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTHL7StructuredDocumentReferenceSequence::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/drthsdrs.h