ml::DcmDRTContourSequenceInterface Class Reference

Class to provide access to DRTContourSequence. More...

#include <mlDcmDRTContourSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTContourSequenceInterface (DRTContourSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTContourSequenceInterface ()
	Default virtual Destructor.
bool	getAttachedContours (unsigned long idx, std::string &parameter)
bool	getAttachedContours (DRTContourSequence::Item &item, std::string &parameter)
std::string	getAttachedContoursTag () const
bool	setAttachedContours (unsigned long idx, std::string &parameter)
bool	getContourData (unsigned long idx, std::string &parameter)
bool	getContourData (DRTContourSequence::Item &item, std::string &parameter)
std::string	getContourDataTag () const
bool	setContourData (unsigned long idx, std::string &parameter)
bool	getContourGeometricType (unsigned long idx, std::string &parameter)
bool	getContourGeometricType (DRTContourSequence::Item &item, std::string &parameter)
std::string	getContourGeometricTypeTag () const
bool	setContourGeometricType (unsigned long idx, std::string &parameter)
bool	getContourNumber (unsigned long idx, std::string &parameter)
bool	getContourNumber (DRTContourSequence::Item &item, std::string &parameter)
std::string	getContourNumberTag () const
bool	setContourNumber (unsigned long idx, std::string &parameter)
bool	getContourOffsetVector (unsigned long idx, std::string &parameter)
bool	getContourOffsetVector (DRTContourSequence::Item &item, std::string &parameter)
std::string	getContourOffsetVectorTag () const
bool	setContourOffsetVector (unsigned long idx, std::string &parameter)
bool	getContourSlabThickness (unsigned long idx, std::string &parameter)
bool	getContourSlabThickness (DRTContourSequence::Item &item, std::string &parameter)
std::string	getContourSlabThicknessTag () const
bool	setContourSlabThickness (unsigned long idx, std::string &parameter)
bool	getNumberOfContourPoints (unsigned long idx, std::string &parameter)
bool	getNumberOfContourPoints (DRTContourSequence::Item &item, std::string &parameter)
std::string	getNumberOfContourPointsTag () const
bool	setNumberOfContourPoints (unsigned long idx, std::string &parameter)
DRTContourImageSequence &	getContourImageSequence (unsigned long idx)
std::string	getContourImageSequenceTag () const
void	setSequence (DRTContourSequence *dcmSequence)
	Set the DRTContourSequence this interface class provides access to.
DRTContourSequence *	getSequence () const
	Return the DRTContourSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTContourSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTContourSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTContourSequence::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
DRTContourSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTContourSequence.

Definition at line 43 of file mlDcmDRTContourSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTContourSequenceInterface::DcmDRTContourSequenceInterface

(

DRTContourSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 47 of file mlDcmDRTContourSequenceInterface.h.

virtual ml::DcmDRTContourSequenceInterface::~DcmDRTContourSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 50 of file mlDcmDRTContourSequenceInterface.h.

---

Member Function Documentation

DRTContourSequence::Item* ml::DcmDRTContourSequenceInterface::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 136 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::getAttachedContours	(	DRTContourSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::getAttachedContours	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTContourSequenceInterface::getAttachedContoursTag

(

)

const [inline]

Definition at line 54 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::getContourData	(	DRTContourSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::getContourData	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTContourSequenceInterface::getContourDataTag

(

)

const [inline]

Definition at line 60 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::getContourGeometricType	(	DRTContourSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::getContourGeometricType	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTContourSequenceInterface::getContourGeometricTypeTag

(

)

const [inline]

Definition at line 66 of file mlDcmDRTContourSequenceInterface.h.

DRTContourImageSequence& ml::DcmDRTContourSequenceInterface::getContourImageSequence

(

unsigned long

idx

)

std::string ml::DcmDRTContourSequenceInterface::getContourImageSequenceTag

(

)

const [inline]

Definition at line 95 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::getContourNumber	(	DRTContourSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::getContourNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTContourSequenceInterface::getContourNumberTag

(

)

const [inline]

Definition at line 72 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::getContourOffsetVector	(	DRTContourSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::getContourOffsetVector	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTContourSequenceInterface::getContourOffsetVectorTag

(

)

const [inline]

Definition at line 78 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::getContourSlabThickness	(	DRTContourSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::getContourSlabThickness	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTContourSequenceInterface::getContourSlabThicknessTag

(

)

const [inline]

Definition at line 84 of file mlDcmDRTContourSequenceInterface.h.

DRTContourSequence::Item* ml::DcmDRTContourSequenceInterface::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 127 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::getNumberOfContourPoints	(	DRTContourSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::getNumberOfContourPoints	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTContourSequenceInterface::getNumberOfContourPointsTag

(

)

const [inline]

Definition at line 90 of file mlDcmDRTContourSequenceInterface.h.

MLint ml::DcmDRTContourSequenceInterface::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 118 of file mlDcmDRTContourSequenceInterface.h.

DRTContourSequence* ml::DcmDRTContourSequenceInterface::getSequence

(

)

const [inline]

Return the DRTContourSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTContourSequence

Definition at line 106 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTContourSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 112 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::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 147 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::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 158 of file mlDcmDRTContourSequenceInterface.h.

bool ml::DcmDRTContourSequenceInterface::setAttachedContours	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::setContourData	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::setContourGeometricType	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::setContourNumber	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::setContourOffsetVector	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::setContourSlabThickness	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTContourSequenceInterface::setNumberOfContourPoints	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTContourSequenceInterface::setSequence

(

DRTContourSequence *

dcmSequence

)

[inline]

Set the DRTContourSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTContourSequence

Definition at line 100 of file mlDcmDRTContourSequenceInterface.h.

---

Member Data Documentation

DRTContourSequence* ml::DcmDRTContourSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 168 of file mlDcmDRTContourSequenceInterface.h.

---

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

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