ml::DcmDRTRangeShifterSettingsSequenceInterface Class Reference

Class to provide access to DRTRangeShifterSettingsSequence. More...

#include <mlDcmDRTRangeShifterSettingsSequenceInterface.h>

List of all members.

Public Member Functions

DcmDRTRangeShifterSettingsSequenceInterface (DRTRangeShifterSettingsSequence *_dcmSequence=NULL)

Default Constructor.

virtual ~DcmDRTRangeShifterSettingsSequenceInterface ()

Default virtual Destructor.

bool getIsocenterToRangeShifterDistance (unsigned long idx, float &parameter)

bool getIsocenterToRangeShifterDistance (DRTRangeShifterSettingsSequence::Item &item, float &parameter)

std::string getIsocenterToRangeShifterDistanceTag () const

bool setIsocenterToRangeShifterDistance (unsigned long idx, float &parameter)

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

bool getRangeShifterSetting (DRTRangeShifterSettingsSequence::Item &item, std::string &parameter)

std::string getRangeShifterSettingTag () const

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

bool getRangeShifterWaterEquivalentThickness (unsigned long idx, float &parameter)

bool getRangeShifterWaterEquivalentThickness (DRTRangeShifterSettingsSequence::Item &item, float &parameter)

std::string getRangeShifterWaterEquivalentThicknessTag () const

bool setRangeShifterWaterEquivalentThickness (unsigned long idx, float &parameter)

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

bool getReferencedRangeShifterNumber (DRTRangeShifterSettingsSequence::Item &item, std::string &parameter)

std::string getReferencedRangeShifterNumberTag () const

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

void setSequence (DRTRangeShifterSettingsSequence *dcmSequence)

Set the DRTRangeShifterSettingsSequence this interface class provides access to.

DRTRangeShifterSettingsSequence * getSequence () const

Return the DRTRangeShifterSettingsSequence this interface class provides access to.

bool hasSequence () const

Check if the DRTRangeShifterSettingsSequence is set.

MLint getNumberOfItems () const

Return number of items the internal sequence consists of.

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

Return number of items the internal sequence consists of.

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

DRTRangeShifterSettingsSequence * _dcmSequence

Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTRangeShifterSettingsSequence.

Definition at line 42 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTRangeShifterSettingsSequenceInterface::DcmDRTRangeShifterSettingsSequenceInterface ( DRTRangeShifterSettingsSequence * _dcmSequence = NULL ) [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

Member Function Documentation

DRTRangeShifterSettingsSequence::Item* ml::DcmDRTRangeShifterSettingsSequenceInterface::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 113 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::getIsocenterToRangeShifterDistance	(	DRTRangeShifterSettingsSequence::Item &	item,
		float &	parameter
	)

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::getIsocenterToRangeShifterDistance	(	unsigned long	idx,
		float &	parameter
	)

std::string ml::DcmDRTRangeShifterSettingsSequenceInterface::getIsocenterToRangeShifterDistanceTag ( ) const [inline]

Definition at line 53 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

DRTRangeShifterSettingsSequence::Item* ml::DcmDRTRangeShifterSettingsSequenceInterface::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 104 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

MLint ml::DcmDRTRangeShifterSettingsSequenceInterface::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 95 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::getRangeShifterSetting	(	DRTRangeShifterSettingsSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::getRangeShifterSetting	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRangeShifterSettingsSequenceInterface::getRangeShifterSettingTag ( ) const [inline]

Definition at line 59 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::getRangeShifterWaterEquivalentThickness	(	DRTRangeShifterSettingsSequence::Item &	item,
		float &	parameter
	)

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::getRangeShifterWaterEquivalentThickness	(	unsigned long	idx,
		float &	parameter
	)

std::string ml::DcmDRTRangeShifterSettingsSequenceInterface::getRangeShifterWaterEquivalentThicknessTag ( ) const [inline]

Definition at line 65 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::getReferencedRangeShifterNumber	(	DRTRangeShifterSettingsSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::getReferencedRangeShifterNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRangeShifterSettingsSequenceInterface::getReferencedRangeShifterNumberTag ( ) const [inline]

Definition at line 71 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

DRTRangeShifterSettingsSequence* ml::DcmDRTRangeShifterSettingsSequenceInterface::getSequence ( ) const [inline]

Return the DRTRangeShifterSettingsSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRangeShifterSettingsSequence

Definition at line 83 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

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

Check if the DRTRangeShifterSettingsSequence is set.

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

Definition at line 89 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::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 124 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::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 135 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::setIsocenterToRangeShifterDistance	(	unsigned long	idx,
		float &	parameter
	)

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::setRangeShifterSetting	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::setRangeShifterWaterEquivalentThickness	(	unsigned long	idx,
		float &	parameter
	)

bool ml::DcmDRTRangeShifterSettingsSequenceInterface::setReferencedRangeShifterNumber	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTRangeShifterSettingsSequenceInterface::setSequence ( DRTRangeShifterSettingsSequence * dcmSequence ) [inline]

Set the DRTRangeShifterSettingsSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRangeShifterSettingsSequence

Definition at line 77 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

Member Data Documentation

DRTRangeShifterSettingsSequence* ml::DcmDRTRangeShifterSettingsSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 145 of file mlDcmDRTRangeShifterSettingsSequenceInterface.h.

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

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


Public Member Functions
	DcmDRTRangeShifterSettingsSequenceInterface (DRTRangeShifterSettingsSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTRangeShifterSettingsSequenceInterface ()
	Default virtual Destructor.
bool	getIsocenterToRangeShifterDistance (unsigned long idx, float &parameter)
bool	getIsocenterToRangeShifterDistance (DRTRangeShifterSettingsSequence::Item &item, float &parameter)
std::string	getIsocenterToRangeShifterDistanceTag () const
bool	setIsocenterToRangeShifterDistance (unsigned long idx, float &parameter)
bool	getRangeShifterSetting (unsigned long idx, std::string &parameter)
bool	getRangeShifterSetting (DRTRangeShifterSettingsSequence::Item &item, std::string &parameter)
std::string	getRangeShifterSettingTag () const
bool	setRangeShifterSetting (unsigned long idx, std::string &parameter)
bool	getRangeShifterWaterEquivalentThickness (unsigned long idx, float &parameter)
bool	getRangeShifterWaterEquivalentThickness (DRTRangeShifterSettingsSequence::Item &item, float &parameter)
std::string	getRangeShifterWaterEquivalentThicknessTag () const
bool	setRangeShifterWaterEquivalentThickness (unsigned long idx, float &parameter)
bool	getReferencedRangeShifterNumber (unsigned long idx, std::string &parameter)
bool	getReferencedRangeShifterNumber (DRTRangeShifterSettingsSequence::Item &item, std::string &parameter)
std::string	getReferencedRangeShifterNumberTag () const
bool	setReferencedRangeShifterNumber (unsigned long idx, std::string &parameter)
void	setSequence (DRTRangeShifterSettingsSequence *dcmSequence)
	Set the DRTRangeShifterSettingsSequence this interface class provides access to.
DRTRangeShifterSettingsSequence *	getSequence () const
	Return the DRTRangeShifterSettingsSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTRangeShifterSettingsSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTRangeShifterSettingsSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTRangeShifterSettingsSequence::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
DRTRangeShifterSettingsSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.