ml::DcmDRTFluenceMapSequenceInterface Class Reference

Class to provide access to DRTFluenceMapSequence. More...

#include <mlDcmDRTFluenceMapSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTFluenceMapSequenceInterface (DRTFluenceMapSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTFluenceMapSequenceInterface ()
	Default virtual Destructor.
bool	getFluenceDataScale (unsigned long idx, std::string &parameter)
bool	getFluenceDataScale (DRTFluenceMapSequence::Item &item, std::string &parameter)
std::string	getFluenceDataScaleTag () const
bool	setFluenceDataScale (unsigned long idx, std::string &parameter)
bool	getFluenceDataSource (unsigned long idx, std::string &parameter)
bool	getFluenceDataSource (DRTFluenceMapSequence::Item &item, std::string &parameter)
std::string	getFluenceDataSourceTag () const
bool	setFluenceDataSource (unsigned long idx, std::string &parameter)
void	setSequence (DRTFluenceMapSequence *dcmSequence)
	Set the DRTFluenceMapSequence this interface class provides access to.
DRTFluenceMapSequence *	getSequence () const
	Return the DRTFluenceMapSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTFluenceMapSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTFluenceMapSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTFluenceMapSequence::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
DRTFluenceMapSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTFluenceMapSequence.

Definition at line 42 of file mlDcmDRTFluenceMapSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTFluenceMapSequenceInterface::DcmDRTFluenceMapSequenceInterface

(

DRTFluenceMapSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTFluenceMapSequenceInterface.h.

virtual ml::DcmDRTFluenceMapSequenceInterface::~DcmDRTFluenceMapSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTFluenceMapSequenceInterface.h.

---

Member Function Documentation

DRTFluenceMapSequence::Item* ml::DcmDRTFluenceMapSequenceInterface::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 101 of file mlDcmDRTFluenceMapSequenceInterface.h.

bool ml::DcmDRTFluenceMapSequenceInterface::getFluenceDataScale	(	DRTFluenceMapSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFluenceMapSequenceInterface::getFluenceDataScale	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFluenceMapSequenceInterface::getFluenceDataScaleTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTFluenceMapSequenceInterface.h.

bool ml::DcmDRTFluenceMapSequenceInterface::getFluenceDataSource	(	DRTFluenceMapSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFluenceMapSequenceInterface::getFluenceDataSource	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFluenceMapSequenceInterface::getFluenceDataSourceTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTFluenceMapSequenceInterface.h.

DRTFluenceMapSequence::Item* ml::DcmDRTFluenceMapSequenceInterface::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 92 of file mlDcmDRTFluenceMapSequenceInterface.h.

MLint ml::DcmDRTFluenceMapSequenceInterface::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 83 of file mlDcmDRTFluenceMapSequenceInterface.h.

DRTFluenceMapSequence* ml::DcmDRTFluenceMapSequenceInterface::getSequence

(

)

const [inline]

Return the DRTFluenceMapSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTFluenceMapSequence

Definition at line 71 of file mlDcmDRTFluenceMapSequenceInterface.h.

bool ml::DcmDRTFluenceMapSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTFluenceMapSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 77 of file mlDcmDRTFluenceMapSequenceInterface.h.

bool ml::DcmDRTFluenceMapSequenceInterface::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 112 of file mlDcmDRTFluenceMapSequenceInterface.h.

bool ml::DcmDRTFluenceMapSequenceInterface::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 123 of file mlDcmDRTFluenceMapSequenceInterface.h.

bool ml::DcmDRTFluenceMapSequenceInterface::setFluenceDataScale	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFluenceMapSequenceInterface::setFluenceDataSource	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTFluenceMapSequenceInterface::setSequence

(

DRTFluenceMapSequence *

dcmSequence

)

[inline]

Set the DRTFluenceMapSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTFluenceMapSequence

Definition at line 65 of file mlDcmDRTFluenceMapSequenceInterface.h.

---

Member Data Documentation

DRTFluenceMapSequence* ml::DcmDRTFluenceMapSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 133 of file mlDcmDRTFluenceMapSequenceInterface.h.

---

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

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