ml::DcmDRTSourceImageSequenceInterface Class Reference

Class to provide access to DRTSourceImageSequence. More...

#include <mlDcmDRTSourceImageSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTSourceImageSequenceInterface ()
	DcmDRTSourceImageSequenceInterface (std::vector< DcmDRTSourceImageSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTSourceImageSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTSourceImageSequenceInterface ()
	Default virtual Destructor.
bool	getPatientOrientation (unsigned long idx, std::string &parameter) const
bool	getPatientOrientation (DCMTree::TreePtr item, std::string &parameter) const
std::string	getPatientOrientationTag () const
bool	setPatientOrientation (unsigned long idx, std::string parameter)
bool	getReferencedFrameNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedFrameNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedFrameNumberTag () const
bool	setReferencedFrameNumber (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	getReferencedSegmentNumber (unsigned long idx, MLuint16 &parameter) const
bool	getReferencedSegmentNumber (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string	getReferencedSegmentNumberTag () const
bool	setReferencedSegmentNumber (unsigned long idx, MLuint16 parameter)
bool	getSpatialLocationsPreserved (unsigned long idx, std::string &parameter) const
bool	getSpatialLocationsPreserved (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSpatialLocationsPreservedTag () const
bool	setSpatialLocationsPreserved (unsigned long idx, std::string parameter)
DcmDRTPurposeOfReferenceCodeSequenceInterface	getPurposeOfReferenceCodeSequence (unsigned long idx) const
std::string	getPurposeOfReferenceCodeSequenceTag () const
void	setPurposeOfReferenceCodeSequence (DcmDRTPurposeOfReferenceCodeSequenceInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTSourceImageSequenceInterface::Item > dcmSequence)
	Set the DRTSourceImageSequence this interface class provides access to.
std::vector< DcmDRTSourceImageSequenceInterface::Item >	getSequence () const
	Return the DRTSourceImageSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTSourceImageSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTSourceImageSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTSourceImageSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTSourceImageSequenceInterface::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< DcmDRTSourceImageSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTSourceImageSequence.

Definition at line 44 of file mlDcmDRTSourceImageSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTSourceImageSequenceInterface() [1/3]

ml::DcmDRTSourceImageSequenceInterface::DcmDRTSourceImageSequenceInterface ( )

inline

Definition at line 109 of file mlDcmDRTSourceImageSequenceInterface.h.

DcmDRTSourceImageSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 112 of file mlDcmDRTSourceImageSequenceInterface.h.

DcmDRTSourceImageSequenceInterface() [3/3]

ml::DcmDRTSourceImageSequenceInterface::DcmDRTSourceImageSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 114 of file mlDcmDRTSourceImageSequenceInterface.h.

~DcmDRTSourceImageSequenceInterface()

virtual ml::DcmDRTSourceImageSequenceInterface::~DcmDRTSourceImageSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 122 of file mlDcmDRTSourceImageSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTSourceImageSequenceInterface::Item & ml::DcmDRTSourceImageSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 200 of file mlDcmDRTSourceImageSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 205 of file mlDcmDRTSourceImageSequenceInterface.h.

getItem()

DcmDRTSourceImageSequenceInterface::Item ml::DcmDRTSourceImageSequenceInterface::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 191 of file mlDcmDRTSourceImageSequenceInterface.h.

getNumberOfItems()

MLint ml::DcmDRTSourceImageSequenceInterface::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 185 of file mlDcmDRTSourceImageSequenceInterface.h.

getPatientOrientation() [1/2]

bool ml::DcmDRTSourceImageSequenceInterface::getPatientOrientation	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getPatientOrientation() [2/2]

bool ml::DcmDRTSourceImageSequenceInterface::getPatientOrientation	(	unsigned long	idx,
		std::string &	parameter
	)		const

getPatientOrientationTag()

std::string ml::DcmDRTSourceImageSequenceInterface::getPatientOrientationTag ( ) const

inline

Definition at line 126 of file mlDcmDRTSourceImageSequenceInterface.h.

Referenced by DRTSourceImageSequenceWrapper::getPatientOrientationTag().

getPurposeOfReferenceCodeSequence()

DcmDRTPurposeOfReferenceCodeSequenceInterface ml::DcmDRTSourceImageSequenceInterface::getPurposeOfReferenceCodeSequence

(

unsigned long

idx

)

const

getPurposeOfReferenceCodeSequenceTag()

std::string ml::DcmDRTSourceImageSequenceInterface::getPurposeOfReferenceCodeSequenceTag ( ) const

inline

Definition at line 161 of file mlDcmDRTSourceImageSequenceInterface.h.

Referenced by DRTSourceImageSequenceWrapper::getPurposeOfReferenceCodeSequenceTag().

getReferencedFrameNumber() [1/2]

bool ml::DcmDRTSourceImageSequenceInterface::getReferencedFrameNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getReferencedFrameNumber() [2/2]

bool ml::DcmDRTSourceImageSequenceInterface::getReferencedFrameNumber	(	unsigned long	idx,
		std::string &	parameter
	)		const

getReferencedFrameNumberTag()

std::string ml::DcmDRTSourceImageSequenceInterface::getReferencedFrameNumberTag ( ) const

inline

Definition at line 132 of file mlDcmDRTSourceImageSequenceInterface.h.

Referenced by DRTSourceImageSequenceWrapper::getReferencedFrameNumberTag().

getReferencedSegmentNumber() [1/2]

bool ml::DcmDRTSourceImageSequenceInterface::getReferencedSegmentNumber	(	DCMTree::TreePtr	item,
		MLuint16 &	parameter
	)		const

getReferencedSegmentNumber() [2/2]

bool ml::DcmDRTSourceImageSequenceInterface::getReferencedSegmentNumber	(	unsigned long	idx,
		MLuint16 &	parameter
	)		const

getReferencedSegmentNumberTag()

std::string ml::DcmDRTSourceImageSequenceInterface::getReferencedSegmentNumberTag ( ) const

inline

Definition at line 150 of file mlDcmDRTSourceImageSequenceInterface.h.

Referenced by DRTSourceImageSequenceWrapper::getReferencedSegmentNumberTag().

getReferencedSOPClassUID() [1/2]

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

getReferencedSOPClassUID() [2/2]

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

getReferencedSOPClassUIDTag()

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

inline

Definition at line 138 of file mlDcmDRTSourceImageSequenceInterface.h.

Referenced by DRTSourceImageSequenceWrapper::getReferencedSOPClassUIDTag().

getReferencedSOPInstanceUID() [1/2]

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

getReferencedSOPInstanceUID() [2/2]

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

getReferencedSOPInstanceUIDTag()

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

inline

Definition at line 144 of file mlDcmDRTSourceImageSequenceInterface.h.

Referenced by DRTSourceImageSequenceWrapper::getReferencedSOPInstanceUIDTag().

getSequence()

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

inline

Return the DRTSourceImageSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTSourceImageSequence

Definition at line 173 of file mlDcmDRTSourceImageSequenceInterface.h.

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

getSpatialLocationsPreserved() [1/2]

bool ml::DcmDRTSourceImageSequenceInterface::getSpatialLocationsPreserved	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getSpatialLocationsPreserved() [2/2]

bool ml::DcmDRTSourceImageSequenceInterface::getSpatialLocationsPreserved	(	unsigned long	idx,
		std::string &	parameter
	)		const

getSpatialLocationsPreservedTag()

std::string ml::DcmDRTSourceImageSequenceInterface::getSpatialLocationsPreservedTag ( ) const

inline

Definition at line 156 of file mlDcmDRTSourceImageSequenceInterface.h.

Referenced by DRTSourceImageSequenceWrapper::getSpatialLocationsPreservedTag().

hasSequence()

bool ml::DcmDRTSourceImageSequenceInterface::hasSequence ( ) const

inline

Check if the DRTSourceImageSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 179 of file mlDcmDRTSourceImageSequenceInterface.h.

insertItem()

bool ml::DcmDRTSourceImageSequenceInterface::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 211 of file mlDcmDRTSourceImageSequenceInterface.h.

removeItem()

bool ml::DcmDRTSourceImageSequenceInterface::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 223 of file mlDcmDRTSourceImageSequenceInterface.h.

setPatientOrientation()

bool ml::DcmDRTSourceImageSequenceInterface::setPatientOrientation	(	unsigned long	idx,
		std::string	parameter
	)

setPurposeOfReferenceCodeSequence()

void ml::DcmDRTSourceImageSequenceInterface::setPurposeOfReferenceCodeSequence	(	DcmDRTPurposeOfReferenceCodeSequenceInterface	seq,
		unsigned long	idx
	)

setReferencedFrameNumber()

bool ml::DcmDRTSourceImageSequenceInterface::setReferencedFrameNumber	(	unsigned long	idx,
		std::string	parameter
	)

setReferencedSegmentNumber()

bool ml::DcmDRTSourceImageSequenceInterface::setReferencedSegmentNumber	(	unsigned long	idx,
		MLuint16	parameter
	)

setReferencedSOPClassUID()

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

setReferencedSOPInstanceUID()

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

setSequence()

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

inline

Set the DRTSourceImageSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTSourceImageSequence

Definition at line 167 of file mlDcmDRTSourceImageSequenceInterface.h.

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

setSpatialLocationsPreserved()

bool ml::DcmDRTSourceImageSequenceInterface::setSpatialLocationsPreserved	(	unsigned long	idx,
		std::string	parameter
	)

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 235 of file mlDcmDRTSourceImageSequenceInterface.h.

---

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

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