ml::DcmDRTFluenceMapSequenceInterface Class Reference

Class to provide access to DRTFluenceMapSequence. More...

#include <mlDcmDRTFluenceMapSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTFluenceMapSequenceInterface ()
	DcmDRTFluenceMapSequenceInterface (std::vector< DcmDRTFluenceMapSequenceInterface::Item > dcmSequence)
	Default Constructor. More...
	DcmDRTFluenceMapSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTFluenceMapSequenceInterface ()
	Default virtual Destructor. More...
bool	getFluenceDataScale (unsigned long idx, std::string &parameter) const
bool	getFluenceDataScale (DCMTree::TreePtr item, std::string &parameter) const
std::string	getFluenceDataScaleTag () const
bool	setFluenceDataScale (unsigned long idx, std::string parameter)
bool	getFluenceDataSource (unsigned long idx, std::string &parameter) const
bool	getFluenceDataSource (DCMTree::TreePtr item, std::string &parameter) const
std::string	getFluenceDataSourceTag () const
bool	setFluenceDataSource (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTFluenceMapSequenceInterface::Item > dcmSequence)
	Set the DRTFluenceMapSequence this interface class provides access to. More...
std::vector< DcmDRTFluenceMapSequenceInterface::Item >	getSequence () const
	Return the DRTFluenceMapSequence this interface class provides access to. More...
bool	hasSequence () const
	Check if the DRTFluenceMapSequence is set. More...
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of. More...
DcmDRTFluenceMapSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position. More...
DcmDRTFluenceMapSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence. More...
void	addItem (DcmDRTFluenceMapSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
	Insert an item at the indicated position. More...
bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence. More...

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

Detailed Description

Class to provide access to DRTFluenceMapSequence.

Definition at line 43 of file mlDcmDRTFluenceMapSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTFluenceMapSequenceInterface() [1/3]

ml::DcmDRTFluenceMapSequenceInterface::DcmDRTFluenceMapSequenceInterface ( )

inline

Definition at line 83 of file mlDcmDRTFluenceMapSequenceInterface.h.

DcmDRTFluenceMapSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTFluenceMapSequenceInterface.h.

DcmDRTFluenceMapSequenceInterface() [3/3]

ml::DcmDRTFluenceMapSequenceInterface::DcmDRTFluenceMapSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTFluenceMapSequenceInterface.h.

~DcmDRTFluenceMapSequenceInterface()

virtual ml::DcmDRTFluenceMapSequenceInterface::~DcmDRTFluenceMapSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTFluenceMapSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTFluenceMapSequenceInterface::Item& ml::DcmDRTFluenceMapSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 145 of file mlDcmDRTFluenceMapSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTFluenceMapSequenceInterface.h.

getFluenceDataScale() [1/2]

bool ml::DcmDRTFluenceMapSequenceInterface::getFluenceDataScale	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getFluenceDataScale() [2/2]

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

getFluenceDataScaleTag()

std::string ml::DcmDRTFluenceMapSequenceInterface::getFluenceDataScaleTag ( ) const

inline

Definition at line 100 of file mlDcmDRTFluenceMapSequenceInterface.h.

Referenced by DRTFluenceMapSequenceWrapper::getFluenceDataScaleTag().

getFluenceDataSource() [1/2]

bool ml::DcmDRTFluenceMapSequenceInterface::getFluenceDataSource	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getFluenceDataSource() [2/2]

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

getFluenceDataSourceTag()

std::string ml::DcmDRTFluenceMapSequenceInterface::getFluenceDataSourceTag ( ) const

inline

Definition at line 106 of file mlDcmDRTFluenceMapSequenceInterface.h.

Referenced by DRTFluenceMapSequenceWrapper::getFluenceDataSourceTag().

getItem()

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

getNumberOfItems()

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 130 of file mlDcmDRTFluenceMapSequenceInterface.h.

getSequence()

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

inline

Return the DRTFluenceMapSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTFluenceMapSequence

Definition at line 118 of file mlDcmDRTFluenceMapSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTFluenceMapSequenceInterface::hasSequence ( ) const

inline

Check if the DRTFluenceMapSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTFluenceMapSequenceInterface.h.

insertItem()

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

removeItem()

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

setFluenceDataScale()

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

setFluenceDataSource()

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

setSequence()

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

inline

Set the DRTFluenceMapSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTFluenceMapSequence

Definition at line 112 of file mlDcmDRTFluenceMapSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTFluenceMapSequenceInterface.h.

---

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

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