ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface Class Reference

Class to provide access to DRTHL7StructuredDocumentReferenceSequence. More...

#include <mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTHL7StructuredDocumentReferenceSequenceInterface ()
	DcmDRTHL7StructuredDocumentReferenceSequenceInterface (std::vector< DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTHL7StructuredDocumentReferenceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTHL7StructuredDocumentReferenceSequenceInterface ()
	Default virtual Destructor.
bool	getHL7InstanceIdentifier (unsigned long idx, std::string &parameter) const
bool	getHL7InstanceIdentifier (DCMTree::TreePtr item, std::string &parameter) const
std::string	getHL7InstanceIdentifierTag () const
bool	setHL7InstanceIdentifier (unsigned long idx, std::string parameter)
bool	getReferencedSOPClassUID (unsigned long idx, std::string &parameter) const
bool	getReferencedSOPClassUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedSOPClassUIDTag () const
bool	setReferencedSOPClassUID (unsigned long idx, std::string parameter)
bool	getReferencedSOPInstanceUID (unsigned long idx, std::string &parameter) const
bool	getReferencedSOPInstanceUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedSOPInstanceUIDTag () const
bool	setReferencedSOPInstanceUID (unsigned long idx, std::string parameter)
bool	getRetrieveURI (unsigned long idx, std::string &parameter) const
bool	getRetrieveURI (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRetrieveURITag () const
bool	setRetrieveURI (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item > dcmSequence)
	Set the DRTHL7StructuredDocumentReferenceSequence this interface class provides access to.
std::vector< DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item >	getSequence () const
	Return the DRTHL7StructuredDocumentReferenceSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTHL7StructuredDocumentReferenceSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
	Insert an item at the indicated position.
bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence.

Protected Attributes
std::vector< DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTHL7StructuredDocumentReferenceSequence.

Definition at line 43 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTHL7StructuredDocumentReferenceSequenceInterface() [1/3]

ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::DcmDRTHL7StructuredDocumentReferenceSequenceInterface ( )

inline

Definition at line 93 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

DcmDRTHL7StructuredDocumentReferenceSequenceInterface() [2/3]

ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::DcmDRTHL7StructuredDocumentReferenceSequenceInterface ( std::vector< DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item > dcmSequence )

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

DcmDRTHL7StructuredDocumentReferenceSequenceInterface() [3/3]

ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::DcmDRTHL7StructuredDocumentReferenceSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

References mlrange_cast().

~DcmDRTHL7StructuredDocumentReferenceSequenceInterface()

virtual ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::~DcmDRTHL7StructuredDocumentReferenceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item & ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 167 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

addItem() [2/2]

void ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::addItem ( DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item newItem )

inline

Definition at line 172 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

References mlrange_cast().

getHL7InstanceIdentifier() [1/2]

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getHL7InstanceIdentifier	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getHL7InstanceIdentifier() [2/2]

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getHL7InstanceIdentifier	(	unsigned long	idx,
		std::string &	parameter ) const

getHL7InstanceIdentifierTag()

std::string ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getHL7InstanceIdentifierTag ( ) const

inline

Definition at line 110 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

Referenced by DRTHL7StructuredDocumentReferenceSequenceWrapper::getHL7InstanceIdentifierTag().

getItem()

DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getItem ( const size_t idx ) const

inline

Gets the item at the indicated position.

Returns

The requested item, an empty item when the position is invalid

Definition at line 158 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getNumberOfItems ( ) const

inline

Return number of items the internal sequence consists of.

Returns

Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 152 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

getReferencedSOPClassUID() [1/2]

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getReferencedSOPClassUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedSOPClassUID() [2/2]

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getReferencedSOPClassUID	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedSOPClassUIDTag()

std::string ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getReferencedSOPClassUIDTag ( ) const

inline

Definition at line 116 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

Referenced by DRTHL7StructuredDocumentReferenceSequenceWrapper::getReferencedSOPClassUIDTag().

getReferencedSOPInstanceUID() [1/2]

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getReferencedSOPInstanceUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedSOPInstanceUID() [2/2]

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getReferencedSOPInstanceUID	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedSOPInstanceUIDTag()

std::string ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getReferencedSOPInstanceUIDTag ( ) const

inline

Definition at line 122 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

Referenced by DRTHL7StructuredDocumentReferenceSequenceWrapper::getReferencedSOPInstanceUIDTag().

getRetrieveURI() [1/2]

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getRetrieveURI	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getRetrieveURI() [2/2]

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getRetrieveURI	(	unsigned long	idx,
		std::string &	parameter ) const

getRetrieveURITag()

std::string ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getRetrieveURITag ( ) const

inline

Definition at line 128 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

Referenced by DRTHL7StructuredDocumentReferenceSequenceWrapper::getRetrieveURITag().

getSequence()

std::vector< DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item > ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::getSequence ( ) const

inline

Return the DRTHL7StructuredDocumentReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTHL7StructuredDocumentReferenceSequence

Definition at line 140 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

Referenced by DRTHL7StructuredDocumentReferenceSequenceItemWrapper::DRTHL7StructuredDocumentReferenceSequenceItemWrapper(), and DRTHL7StructuredDocumentReferenceSequenceItemWrapper::operator=().

hasSequence()

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTHL7StructuredDocumentReferenceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

insertItem()

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::insertItem ( const size_t idx )

inline

Insert an item at the indicated position.

Returns

true is the insertion was successful, false if position is invalid

Definition at line 178 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::removeItem ( const size_t idx )

inline

Removes the indicated item from the sequence.

Returns

true if the item was deleted successfully, false if the indicated position is invalid

Definition at line 190 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

References mlrange_cast().

setHL7InstanceIdentifier()

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::setHL7InstanceIdentifier	(	unsigned long	idx,
		std::string	parameter )

setReferencedSOPClassUID()

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::setReferencedSOPClassUID	(	unsigned long	idx,
		std::string	parameter )

setReferencedSOPInstanceUID()

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::setReferencedSOPInstanceUID	(	unsigned long	idx,
		std::string	parameter )

setRetrieveURI()

bool ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::setRetrieveURI	(	unsigned long	idx,
		std::string	parameter )

setSequence()

void ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::setSequence ( std::vector< DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item > dcmSequence )

inline

Set the DRTHL7StructuredDocumentReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTHL7StructuredDocumentReferenceSequence

Definition at line 134 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

References mlrange_cast().

Referenced by DRTHL7StructuredDocumentReferenceSequenceWrapper::DRTHL7StructuredDocumentReferenceSequenceWrapper(), and DRTHL7StructuredDocumentReferenceSequenceWrapper::operator=().

Member Data Documentation

_itemVec

std::vector<DcmDRTHL7StructuredDocumentReferenceSequenceInterface::Item> ml::DcmDRTHL7StructuredDocumentReferenceSequenceInterface::_itemVec

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h.

---

The documentation for this class was generated from the following file:

• FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTHL7StructuredDocumentReferenceSequenceInterface.h