ml::DcmDRTSourceImageSequenceInterface Class Reference

Class to provide access to DRTSourceImageSequence. More...

#include <mlDcmDRTSourceImageSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTSourceImageSequenceInterface (DRTSourceImageSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTSourceImageSequenceInterface ()
	Default virtual Destructor.
bool	getPatientOrientation (unsigned long idx, std::string &parameter)
bool	getPatientOrientation (DRTSourceImageSequence::Item &item, std::string &parameter)
std::string	getPatientOrientationTag () const
bool	setPatientOrientation (unsigned long idx, std::string &parameter)
bool	getReferencedFrameNumber (unsigned long idx, std::string &parameter)
bool	getReferencedFrameNumber (DRTSourceImageSequence::Item &item, std::string &parameter)
std::string	getReferencedFrameNumberTag () const
bool	setReferencedFrameNumber (unsigned long idx, std::string &parameter)
bool	getReferencedSOPClassUID (unsigned long idx, std::string &parameter)
bool	getReferencedSOPClassUID (DRTSourceImageSequence::Item &item, std::string &parameter)
std::string	getReferencedSOPClassUIDTag () const
bool	setReferencedSOPClassUID (unsigned long idx, std::string &parameter)
bool	getReferencedSOPInstanceUID (unsigned long idx, std::string &parameter)
bool	getReferencedSOPInstanceUID (DRTSourceImageSequence::Item &item, std::string &parameter)
std::string	getReferencedSOPInstanceUIDTag () const
bool	setReferencedSOPInstanceUID (unsigned long idx, std::string &parameter)
bool	getReferencedSegmentNumber (unsigned long idx, MLuint16 &parameter)
bool	getReferencedSegmentNumber (DRTSourceImageSequence::Item &item, MLuint16 &parameter)
std::string	getReferencedSegmentNumberTag () const
bool	setReferencedSegmentNumber (unsigned long idx, MLuint16 &parameter)
bool	getSpatialLocationsPreserved (unsigned long idx, std::string &parameter)
bool	getSpatialLocationsPreserved (DRTSourceImageSequence::Item &item, std::string &parameter)
std::string	getSpatialLocationsPreservedTag () const
bool	setSpatialLocationsPreserved (unsigned long idx, std::string &parameter)
DRTPurposeOfReferenceCodeSequence &	getPurposeOfReferenceCodeSequence (unsigned long idx)
std::string	getPurposeOfReferenceCodeSequenceTag () const
void	setSequence (DRTSourceImageSequence *dcmSequence)
	Set the DRTSourceImageSequence this interface class provides access to.
DRTSourceImageSequence *	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.
DRTSourceImageSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTSourceImageSequence::Item *	addItem ()
	Return number of items the internal sequence consists of.
bool	insertItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
bool	removeItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
Protected Attributes
DRTSourceImageSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTSourceImageSequence.

Definition at line 43 of file mlDcmDRTSourceImageSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTSourceImageSequenceInterface::DcmDRTSourceImageSequenceInterface

(

DRTSourceImageSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 47 of file mlDcmDRTSourceImageSequenceInterface.h.

virtual ml::DcmDRTSourceImageSequenceInterface::~DcmDRTSourceImageSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 50 of file mlDcmDRTSourceImageSequenceInterface.h.

---

Member Function Documentation

DRTSourceImageSequence::Item* ml::DcmDRTSourceImageSequenceInterface::addItem

(

)

[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 130 of file mlDcmDRTSourceImageSequenceInterface.h.

DRTSourceImageSequence::Item* ml::DcmDRTSourceImageSequenceInterface::getItem

(

const unsigned long

idx

)

[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 121 of file mlDcmDRTSourceImageSequenceInterface.h.

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 112 of file mlDcmDRTSourceImageSequenceInterface.h.

bool ml::DcmDRTSourceImageSequenceInterface::getPatientOrientation	(	DRTSourceImageSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTSourceImageSequenceInterface::getPatientOrientationTag

(

)

const [inline]

Definition at line 54 of file mlDcmDRTSourceImageSequenceInterface.h.

DRTPurposeOfReferenceCodeSequence& ml::DcmDRTSourceImageSequenceInterface::getPurposeOfReferenceCodeSequence

(

unsigned long

idx

)

std::string ml::DcmDRTSourceImageSequenceInterface::getPurposeOfReferenceCodeSequenceTag

(

)

const [inline]

Definition at line 89 of file mlDcmDRTSourceImageSequenceInterface.h.

bool ml::DcmDRTSourceImageSequenceInterface::getReferencedFrameNumber	(	DRTSourceImageSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTSourceImageSequenceInterface::getReferencedFrameNumberTag

(

)

const [inline]

Definition at line 60 of file mlDcmDRTSourceImageSequenceInterface.h.

bool ml::DcmDRTSourceImageSequenceInterface::getReferencedSegmentNumber	(	DRTSourceImageSequence::Item &	item,
		MLuint16 &	parameter
	)

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

std::string ml::DcmDRTSourceImageSequenceInterface::getReferencedSegmentNumberTag

(

)

const [inline]

Definition at line 78 of file mlDcmDRTSourceImageSequenceInterface.h.

bool ml::DcmDRTSourceImageSequenceInterface::getReferencedSOPClassUID	(	DRTSourceImageSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTSourceImageSequenceInterface::getReferencedSOPClassUIDTag

(

)

const [inline]

Definition at line 66 of file mlDcmDRTSourceImageSequenceInterface.h.

bool ml::DcmDRTSourceImageSequenceInterface::getReferencedSOPInstanceUID	(	DRTSourceImageSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTSourceImageSequenceInterface::getReferencedSOPInstanceUIDTag

(

)

const [inline]

Definition at line 72 of file mlDcmDRTSourceImageSequenceInterface.h.

DRTSourceImageSequence* ml::DcmDRTSourceImageSequenceInterface::getSequence

(

)

const [inline]

Return the DRTSourceImageSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTSourceImageSequence

Definition at line 100 of file mlDcmDRTSourceImageSequenceInterface.h.

bool ml::DcmDRTSourceImageSequenceInterface::getSpatialLocationsPreserved	(	DRTSourceImageSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTSourceImageSequenceInterface::getSpatialLocationsPreservedTag

(

)

const [inline]

Definition at line 84 of file mlDcmDRTSourceImageSequenceInterface.h.

bool ml::DcmDRTSourceImageSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTSourceImageSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 106 of file mlDcmDRTSourceImageSequenceInterface.h.

bool ml::DcmDRTSourceImageSequenceInterface::insertItem

(

const unsigned long

idx

)

[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 141 of file mlDcmDRTSourceImageSequenceInterface.h.

bool ml::DcmDRTSourceImageSequenceInterface::removeItem

(

const unsigned long

idx

)

[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 mlDcmDRTSourceImageSequenceInterface.h.

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

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

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

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

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

void ml::DcmDRTSourceImageSequenceInterface::setSequence

(

DRTSourceImageSequence *

dcmSequence

)

[inline]

Set the DRTSourceImageSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTSourceImageSequence

Definition at line 94 of file mlDcmDRTSourceImageSequenceInterface.h.

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

---

Member Data Documentation

DRTSourceImageSequence* ml::DcmDRTSourceImageSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 162 of file mlDcmDRTSourceImageSequenceInterface.h.

---

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

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