ml::DcmDRTRangeModulatorSettingsSequenceInterface Class Reference

Class to provide access to DRTRangeModulatorSettingsSequence. More...

#include <mlDcmDRTRangeModulatorSettingsSequenceInterface.h>

List of all members.

Public Member Functions

DcmDRTRangeModulatorSettingsSequenceInterface (DRTRangeModulatorSettingsSequence *_dcmSequence=NULL)

Default Constructor.

virtual ~DcmDRTRangeModulatorSettingsSequenceInterface ()

Default virtual Destructor.

bool getIsocenterToRangeModulatorDistance (unsigned long idx, float &parameter)

bool getIsocenterToRangeModulatorDistance (DRTRangeModulatorSettingsSequence::Item &item, float &parameter)

std::string getIsocenterToRangeModulatorDistanceTag () const

bool setIsocenterToRangeModulatorDistance (unsigned long idx, float &parameter)

bool getRangeModulatorGatingStartValue (unsigned long idx, float &parameter)

bool getRangeModulatorGatingStartValue (DRTRangeModulatorSettingsSequence::Item &item, float &parameter)

std::string getRangeModulatorGatingStartValueTag () const

bool setRangeModulatorGatingStartValue (unsigned long idx, float &parameter)

bool getRangeModulatorGatingStartWaterEquivalentThickness (unsigned long idx, float &parameter)

bool getRangeModulatorGatingStartWaterEquivalentThickness (DRTRangeModulatorSettingsSequence::Item &item, float &parameter)

std::string getRangeModulatorGatingStartWaterEquivalentThicknessTag () const

bool setRangeModulatorGatingStartWaterEquivalentThickness (unsigned long idx, float &parameter)

bool getRangeModulatorGatingStopValue (unsigned long idx, float &parameter)

bool getRangeModulatorGatingStopValue (DRTRangeModulatorSettingsSequence::Item &item, float &parameter)

std::string getRangeModulatorGatingStopValueTag () const

bool setRangeModulatorGatingStopValue (unsigned long idx, float &parameter)

bool getRangeModulatorGatingStopWaterEquivalentThickness (unsigned long idx, float &parameter)

bool getRangeModulatorGatingStopWaterEquivalentThickness (DRTRangeModulatorSettingsSequence::Item &item, float &parameter)

std::string getRangeModulatorGatingStopWaterEquivalentThicknessTag () const

bool setRangeModulatorGatingStopWaterEquivalentThickness (unsigned long idx, float &parameter)

bool getReferencedRangeModulatorNumber (unsigned long idx, std::string &parameter)

bool getReferencedRangeModulatorNumber (DRTRangeModulatorSettingsSequence::Item &item, std::string &parameter)

std::string getReferencedRangeModulatorNumberTag () const

bool setReferencedRangeModulatorNumber (unsigned long idx, std::string &parameter)

void setSequence (DRTRangeModulatorSettingsSequence *dcmSequence)

Set the DRTRangeModulatorSettingsSequence this interface class provides access to.

DRTRangeModulatorSettingsSequence * getSequence () const

Return the DRTRangeModulatorSettingsSequence this interface class provides access to.

bool hasSequence () const

Check if the DRTRangeModulatorSettingsSequence is set.

MLint getNumberOfItems () const

Return number of items the internal sequence consists of.

DRTRangeModulatorSettingsSequence::Item * getItem (const unsigned long idx)

Return number of items the internal sequence consists of.

DRTRangeModulatorSettingsSequence::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

DRTRangeModulatorSettingsSequence * _dcmSequence

Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTRangeModulatorSettingsSequence.

Definition at line 42 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTRangeModulatorSettingsSequenceInterface::DcmDRTRangeModulatorSettingsSequenceInterface ( DRTRangeModulatorSettingsSequence * _dcmSequence = NULL ) [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

virtual ml::DcmDRTRangeModulatorSettingsSequenceInterface::~DcmDRTRangeModulatorSettingsSequenceInterface ( ) [inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

Member Function Documentation

DRTRangeModulatorSettingsSequence::Item* ml::DcmDRTRangeModulatorSettingsSequenceInterface::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 125 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getIsocenterToRangeModulatorDistance	(	DRTRangeModulatorSettingsSequence::Item &	item,
		float &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getIsocenterToRangeModulatorDistance	(	unsigned long	idx,
		float &	parameter
	)

std::string ml::DcmDRTRangeModulatorSettingsSequenceInterface::getIsocenterToRangeModulatorDistanceTag ( ) const [inline]

Definition at line 53 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

DRTRangeModulatorSettingsSequence::Item* ml::DcmDRTRangeModulatorSettingsSequenceInterface::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 116 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

MLint ml::DcmDRTRangeModulatorSettingsSequenceInterface::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 107 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStartValue	(	DRTRangeModulatorSettingsSequence::Item &	item,
		float &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStartValue	(	unsigned long	idx,
		float &	parameter
	)

std::string ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStartValueTag ( ) const [inline]

Definition at line 59 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStartWaterEquivalentThickness	(	DRTRangeModulatorSettingsSequence::Item &	item,
		float &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStartWaterEquivalentThickness	(	unsigned long	idx,
		float &	parameter
	)

std::string ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStartWaterEquivalentThicknessTag ( ) const [inline]

Definition at line 65 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStopValue	(	DRTRangeModulatorSettingsSequence::Item &	item,
		float &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStopValue	(	unsigned long	idx,
		float &	parameter
	)

std::string ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStopValueTag ( ) const [inline]

Definition at line 71 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStopWaterEquivalentThickness	(	DRTRangeModulatorSettingsSequence::Item &	item,
		float &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStopWaterEquivalentThickness	(	unsigned long	idx,
		float &	parameter
	)

std::string ml::DcmDRTRangeModulatorSettingsSequenceInterface::getRangeModulatorGatingStopWaterEquivalentThicknessTag ( ) const [inline]

Definition at line 77 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getReferencedRangeModulatorNumber	(	DRTRangeModulatorSettingsSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::getReferencedRangeModulatorNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRangeModulatorSettingsSequenceInterface::getReferencedRangeModulatorNumberTag ( ) const [inline]

Definition at line 83 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

DRTRangeModulatorSettingsSequence* ml::DcmDRTRangeModulatorSettingsSequenceInterface::getSequence ( ) const [inline]

Return the DRTRangeModulatorSettingsSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRangeModulatorSettingsSequence

Definition at line 95 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::hasSequence ( ) const [inline]

Check if the DRTRangeModulatorSettingsSequence is set.

Returns:: True if internal pointer is set, False else.

Definition at line 101 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::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 136 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

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

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::setIsocenterToRangeModulatorDistance	(	unsigned long	idx,
		float &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::setRangeModulatorGatingStartValue	(	unsigned long	idx,
		float &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::setRangeModulatorGatingStartWaterEquivalentThickness	(	unsigned long	idx,
		float &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::setRangeModulatorGatingStopValue	(	unsigned long	idx,
		float &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::setRangeModulatorGatingStopWaterEquivalentThickness	(	unsigned long	idx,
		float &	parameter
	)

bool ml::DcmDRTRangeModulatorSettingsSequenceInterface::setReferencedRangeModulatorNumber	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTRangeModulatorSettingsSequenceInterface::setSequence ( DRTRangeModulatorSettingsSequence * dcmSequence ) [inline]

Set the DRTRangeModulatorSettingsSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRangeModulatorSettingsSequence

Definition at line 89 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

Member Data Documentation

DRTRangeModulatorSettingsSequence* ml::DcmDRTRangeModulatorSettingsSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 157 of file mlDcmDRTRangeModulatorSettingsSequenceInterface.h.

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

FMEwork/Release/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTRangeModulatorSettingsSequenceInterface.h


Public Member Functions
	DcmDRTRangeModulatorSettingsSequenceInterface (DRTRangeModulatorSettingsSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTRangeModulatorSettingsSequenceInterface ()
	Default virtual Destructor.
bool	getIsocenterToRangeModulatorDistance (unsigned long idx, float &parameter)
bool	getIsocenterToRangeModulatorDistance (DRTRangeModulatorSettingsSequence::Item &item, float &parameter)
std::string	getIsocenterToRangeModulatorDistanceTag () const
bool	setIsocenterToRangeModulatorDistance (unsigned long idx, float &parameter)
bool	getRangeModulatorGatingStartValue (unsigned long idx, float &parameter)
bool	getRangeModulatorGatingStartValue (DRTRangeModulatorSettingsSequence::Item &item, float &parameter)
std::string	getRangeModulatorGatingStartValueTag () const
bool	setRangeModulatorGatingStartValue (unsigned long idx, float &parameter)
bool	getRangeModulatorGatingStartWaterEquivalentThickness (unsigned long idx, float &parameter)
bool	getRangeModulatorGatingStartWaterEquivalentThickness (DRTRangeModulatorSettingsSequence::Item &item, float &parameter)
std::string	getRangeModulatorGatingStartWaterEquivalentThicknessTag () const
bool	setRangeModulatorGatingStartWaterEquivalentThickness (unsigned long idx, float &parameter)
bool	getRangeModulatorGatingStopValue (unsigned long idx, float &parameter)
bool	getRangeModulatorGatingStopValue (DRTRangeModulatorSettingsSequence::Item &item, float &parameter)
std::string	getRangeModulatorGatingStopValueTag () const
bool	setRangeModulatorGatingStopValue (unsigned long idx, float &parameter)
bool	getRangeModulatorGatingStopWaterEquivalentThickness (unsigned long idx, float &parameter)
bool	getRangeModulatorGatingStopWaterEquivalentThickness (DRTRangeModulatorSettingsSequence::Item &item, float &parameter)
std::string	getRangeModulatorGatingStopWaterEquivalentThicknessTag () const
bool	setRangeModulatorGatingStopWaterEquivalentThickness (unsigned long idx, float &parameter)
bool	getReferencedRangeModulatorNumber (unsigned long idx, std::string &parameter)
bool	getReferencedRangeModulatorNumber (DRTRangeModulatorSettingsSequence::Item &item, std::string &parameter)
std::string	getReferencedRangeModulatorNumberTag () const
bool	setReferencedRangeModulatorNumber (unsigned long idx, std::string &parameter)
void	setSequence (DRTRangeModulatorSettingsSequence *dcmSequence)
	Set the DRTRangeModulatorSettingsSequence this interface class provides access to.
DRTRangeModulatorSettingsSequence *	getSequence () const
	Return the DRTRangeModulatorSettingsSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTRangeModulatorSettingsSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTRangeModulatorSettingsSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTRangeModulatorSettingsSequence::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
DRTRangeModulatorSettingsSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.