ml::DcmDRTROIContourSequenceInterface Class Reference

Class to provide access to DRTROIContourSequence. More...

#include <mlDcmDRTROIContourSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTROIContourSequenceInterface (DRTROIContourSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTROIContourSequenceInterface ()
	Default virtual Destructor.
bool	getROIDisplayColor (unsigned long idx, std::string &parameter)
bool	getROIDisplayColor (DRTROIContourSequence::Item &item, std::string &parameter)
std::string	getROIDisplayColorTag () const
bool	setROIDisplayColor (unsigned long idx, std::string &parameter)
bool	getReferencedROINumber (unsigned long idx, std::string &parameter)
bool	getReferencedROINumber (DRTROIContourSequence::Item &item, std::string &parameter)
std::string	getReferencedROINumberTag () const
bool	setReferencedROINumber (unsigned long idx, std::string &parameter)
DRTContourSequence &	getContourSequence (unsigned long idx)
std::string	getContourSequenceTag () const
void	setSequence (DRTROIContourSequence *dcmSequence)
	Set the DRTROIContourSequence this interface class provides access to.
DRTROIContourSequence *	getSequence () const
	Return the DRTROIContourSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTROIContourSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTROIContourSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTROIContourSequence::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
DRTROIContourSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTROIContourSequence.

Definition at line 43 of file mlDcmDRTROIContourSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTROIContourSequenceInterface::DcmDRTROIContourSequenceInterface

(

DRTROIContourSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 47 of file mlDcmDRTROIContourSequenceInterface.h.

virtual ml::DcmDRTROIContourSequenceInterface::~DcmDRTROIContourSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 50 of file mlDcmDRTROIContourSequenceInterface.h.

---

Member Function Documentation

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

DRTContourSequence& ml::DcmDRTROIContourSequenceInterface::getContourSequence

(

unsigned long

idx

)

std::string ml::DcmDRTROIContourSequenceInterface::getContourSequenceTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTROIContourSequenceInterface.h.

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

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 88 of file mlDcmDRTROIContourSequenceInterface.h.

bool ml::DcmDRTROIContourSequenceInterface::getReferencedROINumber	(	DRTROIContourSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTROIContourSequenceInterface::getReferencedROINumberTag

(

)

const [inline]

Definition at line 60 of file mlDcmDRTROIContourSequenceInterface.h.

bool ml::DcmDRTROIContourSequenceInterface::getROIDisplayColor	(	DRTROIContourSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTROIContourSequenceInterface::getROIDisplayColorTag

(

)

const [inline]

Definition at line 54 of file mlDcmDRTROIContourSequenceInterface.h.

DRTROIContourSequence* ml::DcmDRTROIContourSequenceInterface::getSequence

(

)

const [inline]

Return the DRTROIContourSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTROIContourSequence

Definition at line 76 of file mlDcmDRTROIContourSequenceInterface.h.

bool ml::DcmDRTROIContourSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTROIContourSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 82 of file mlDcmDRTROIContourSequenceInterface.h.

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

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

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

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

void ml::DcmDRTROIContourSequenceInterface::setSequence

(

DRTROIContourSequence *

dcmSequence

)

[inline]

Set the DRTROIContourSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTROIContourSequence

Definition at line 70 of file mlDcmDRTROIContourSequenceInterface.h.

---

Member Data Documentation

DRTROIContourSequence* ml::DcmDRTROIContourSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 138 of file mlDcmDRTROIContourSequenceInterface.h.

---

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

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