ml::DcmDRTROIContourSequenceInterface Class Reference

Class to provide access to DRTROIContourSequence. More...

#include <mlDcmDRTROIContourSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTROIContourSequenceInterface ()
	DcmDRTROIContourSequenceInterface (std::vector< DcmDRTROIContourSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTROIContourSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTROIContourSequenceInterface ()
	Default virtual Destructor.
bool	getROIDisplayColor (unsigned long idx, std::string &parameter) const
bool	getROIDisplayColor (DCMTree::TreePtr item, std::string &parameter) const
std::string	getROIDisplayColorTag () const
bool	setROIDisplayColor (unsigned long idx, std::string parameter)
bool	getReferencedROINumber (unsigned long idx, std::string &parameter) const
bool	getReferencedROINumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedROINumberTag () const
bool	setReferencedROINumber (unsigned long idx, std::string parameter)
DcmDRTContourSequenceInterface	getContourSequence (unsigned long idx) const
std::string	getContourSequenceTag () const
void	setContourSequence (DcmDRTContourSequenceInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTROIContourSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTROIContourSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTROIContourSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTROIContourSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTROIContourSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTROIContourSequence.

Definition at line 44 of file mlDcmDRTROIContourSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTROIContourSequenceInterface() [1/3]

ml::DcmDRTROIContourSequenceInterface::DcmDRTROIContourSequenceInterface ( )

inline

Definition at line 89 of file mlDcmDRTROIContourSequenceInterface.h.

DcmDRTROIContourSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 92 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

DcmDRTROIContourSequenceInterface() [3/3]

ml::DcmDRTROIContourSequenceInterface::DcmDRTROIContourSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 94 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

~DcmDRTROIContourSequenceInterface()

virtual ml::DcmDRTROIContourSequenceInterface::~DcmDRTROIContourSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 102 of file mlDcmDRTROIContourSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTROIContourSequenceInterface::Item & ml::DcmDRTROIContourSequenceInterface::addItem ( )

inline

Adds a new item to the sequence

Returns

Return the new item which has been added to the sequence

Definition at line 156 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

getContourSequence()

DcmDRTContourSequenceInterface ml::DcmDRTROIContourSequenceInterface::getContourSequence

(

unsigned long

idx

)

const

getContourSequenceTag()

std::string ml::DcmDRTROIContourSequenceInterface::getContourSequenceTag ( ) const

inline

Definition at line 117 of file mlDcmDRTROIContourSequenceInterface.h.

getItem()

DcmDRTROIContourSequenceInterface::Item ml::DcmDRTROIContourSequenceInterface::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 147 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTROIContourSequenceInterface::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 141 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

getReferencedROINumber() [1/2]

bool ml::DcmDRTROIContourSequenceInterface::getReferencedROINumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedROINumber() [2/2]

bool ml::DcmDRTROIContourSequenceInterface::getReferencedROINumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedROINumberTag()

std::string ml::DcmDRTROIContourSequenceInterface::getReferencedROINumberTag ( ) const

inline

Definition at line 112 of file mlDcmDRTROIContourSequenceInterface.h.

getROIDisplayColor() [1/2]

bool ml::DcmDRTROIContourSequenceInterface::getROIDisplayColor	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getROIDisplayColor() [2/2]

bool ml::DcmDRTROIContourSequenceInterface::getROIDisplayColor	(	unsigned long	idx,
		std::string &	parameter ) const

getROIDisplayColorTag()

std::string ml::DcmDRTROIContourSequenceInterface::getROIDisplayColorTag ( ) const

inline

Definition at line 106 of file mlDcmDRTROIContourSequenceInterface.h.

getSequence()

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

inline

Return the DRTROIContourSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTROIContourSequence

Definition at line 129 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTROIContourSequenceInterface::hasSequence ( ) const

inline

Check if the DRTROIContourSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTROIContourSequenceInterface::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 167 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTROIContourSequenceInterface::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 179 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

setContourSequence()

void ml::DcmDRTROIContourSequenceInterface::setContourSequence	(	DcmDRTContourSequenceInterface	seq,
		unsigned long	idx )

setReferencedROINumber()

bool ml::DcmDRTROIContourSequenceInterface::setReferencedROINumber	(	unsigned long	idx,
		std::string	parameter )

setROIDisplayColor()

bool ml::DcmDRTROIContourSequenceInterface::setROIDisplayColor	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTROIContourSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTROIContourSequence

Definition at line 123 of file mlDcmDRTROIContourSequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTROIContourSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTROIContourSequenceInterface(), DcmDRTROIContourSequenceInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

---

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

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