ml::DcmDRTContourImageSequenceInterface Class Reference

Class to provide access to DRTContourImageSequence. More...

#include <mlDcmDRTContourImageSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTContourImageSequenceInterface ()
	DcmDRTContourImageSequenceInterface (std::vector< DcmDRTContourImageSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTContourImageSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTContourImageSequenceInterface ()
	Default virtual Destructor.
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)
void	setSequence (std::vector< DcmDRTContourImageSequenceInterface::Item > dcmSequence)
	Set the DRTContourImageSequence this interface class provides access to.
std::vector< DcmDRTContourImageSequenceInterface::Item >	getSequence () const
	Return the DRTContourImageSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTContourImageSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTContourImageSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTContourImageSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTContourImageSequenceInterface::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< DcmDRTContourImageSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTContourImageSequence.

Definition at line 43 of file mlDcmDRTContourImageSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTContourImageSequenceInterface() [1/3]

ml::DcmDRTContourImageSequenceInterface::DcmDRTContourImageSequenceInterface ( )

inline

Definition at line 93 of file mlDcmDRTContourImageSequenceInterface.h.

DcmDRTContourImageSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTContourImageSequenceInterface.h.

DcmDRTContourImageSequenceInterface() [3/3]

ml::DcmDRTContourImageSequenceInterface::DcmDRTContourImageSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTContourImageSequenceInterface.h.

~DcmDRTContourImageSequenceInterface()

virtual ml::DcmDRTContourImageSequenceInterface::~DcmDRTContourImageSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTContourImageSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTContourImageSequenceInterface::Item & ml::DcmDRTContourImageSequenceInterface::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 mlDcmDRTContourImageSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTContourImageSequenceInterface.h.

getItem()

DcmDRTContourImageSequenceInterface::Item ml::DcmDRTContourImageSequenceInterface::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 mlDcmDRTContourImageSequenceInterface.h.

getNumberOfItems()

MLint ml::DcmDRTContourImageSequenceInterface::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 mlDcmDRTContourImageSequenceInterface.h.

getReferencedFrameNumber() [1/2]

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

getReferencedFrameNumber() [2/2]

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

getReferencedFrameNumberTag()

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

inline

Definition at line 110 of file mlDcmDRTContourImageSequenceInterface.h.

Referenced by DRTContourImageSequenceWrapper::getReferencedFrameNumberTag().

getReferencedSegmentNumber() [1/2]

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

getReferencedSegmentNumber() [2/2]

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

getReferencedSegmentNumberTag()

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

inline

Definition at line 128 of file mlDcmDRTContourImageSequenceInterface.h.

Referenced by DRTContourImageSequenceWrapper::getReferencedSegmentNumberTag().

getReferencedSOPClassUID() [1/2]

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

getReferencedSOPClassUID() [2/2]

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

getReferencedSOPClassUIDTag()

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

inline

Definition at line 116 of file mlDcmDRTContourImageSequenceInterface.h.

Referenced by DRTContourImageSequenceWrapper::getReferencedSOPClassUIDTag().

getReferencedSOPInstanceUID() [1/2]

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

getReferencedSOPInstanceUID() [2/2]

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

getReferencedSOPInstanceUIDTag()

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

inline

Definition at line 122 of file mlDcmDRTContourImageSequenceInterface.h.

Referenced by DRTContourImageSequenceWrapper::getReferencedSOPInstanceUIDTag().

getSequence()

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

inline

Return the DRTContourImageSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTContourImageSequence

Definition at line 140 of file mlDcmDRTContourImageSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTContourImageSequenceInterface::hasSequence ( ) const

inline

Check if the DRTContourImageSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTContourImageSequenceInterface.h.

insertItem()

bool ml::DcmDRTContourImageSequenceInterface::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 mlDcmDRTContourImageSequenceInterface.h.

removeItem()

bool ml::DcmDRTContourImageSequenceInterface::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 mlDcmDRTContourImageSequenceInterface.h.

setReferencedFrameNumber()

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

setReferencedSegmentNumber()

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

setReferencedSOPClassUID()

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

setReferencedSOPInstanceUID()

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

setSequence()

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

inline

Set the DRTContourImageSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTContourImageSequence

Definition at line 134 of file mlDcmDRTContourImageSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTContourImageSequenceInterface.h.

---

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

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