ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface Class Reference

Class to provide access to DRTRangeModulatorSettingsSequenceInRTIonBeamsModule. More...

#include <mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface ()
	DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface (std::vector< DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface ()
	Default virtual Destructor.
bool	getIsocenterToRangeModulatorDistance (unsigned long idx, float &parameter) const
bool	getIsocenterToRangeModulatorDistance (DCMTree::TreePtr item, float &parameter) const
std::string	getIsocenterToRangeModulatorDistanceTag () const
bool	setIsocenterToRangeModulatorDistance (unsigned long idx, float parameter)
bool	getRangeModulatorGatingStartValue (unsigned long idx, float &parameter) const
bool	getRangeModulatorGatingStartValue (DCMTree::TreePtr item, float &parameter) const
std::string	getRangeModulatorGatingStartValueTag () const
bool	setRangeModulatorGatingStartValue (unsigned long idx, float parameter)
bool	getRangeModulatorGatingStartWaterEquivalentThickness (unsigned long idx, float &parameter) const
bool	getRangeModulatorGatingStartWaterEquivalentThickness (DCMTree::TreePtr item, float &parameter) const
std::string	getRangeModulatorGatingStartWaterEquivalentThicknessTag () const
bool	setRangeModulatorGatingStartWaterEquivalentThickness (unsigned long idx, float parameter)
bool	getRangeModulatorGatingStopValue (unsigned long idx, float &parameter) const
bool	getRangeModulatorGatingStopValue (DCMTree::TreePtr item, float &parameter) const
std::string	getRangeModulatorGatingStopValueTag () const
bool	setRangeModulatorGatingStopValue (unsigned long idx, float parameter)
bool	getRangeModulatorGatingStopWaterEquivalentThickness (unsigned long idx, float &parameter) const
bool	getRangeModulatorGatingStopWaterEquivalentThickness (DCMTree::TreePtr item, float &parameter) const
std::string	getRangeModulatorGatingStopWaterEquivalentThicknessTag () const
bool	setRangeModulatorGatingStopWaterEquivalentThickness (unsigned long idx, float parameter)
bool	getReferencedRangeModulatorNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedRangeModulatorNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedRangeModulatorNumberTag () const
bool	setReferencedRangeModulatorNumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
	Set the DRTRangeModulatorSettingsSequenceInRTIonBeamsModule this interface class provides access to.
std::vector< DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item >	getSequence () const
	Return the DRTRangeModulatorSettingsSequenceInRTIonBeamsModule this interface class provides access to.
bool	hasSequence () const
	Check if the DRTRangeModulatorSettingsSequenceInRTIonBeamsModule is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
	Insert an item at the indicated position.
bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence.

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

Detailed Description

Class to provide access to DRTRangeModulatorSettingsSequenceInRTIonBeamsModule.

Definition at line 43 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface() [1/3]

ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface ( )

inline

Definition at line 103 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 106 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface() [3/3]

ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 108 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

~DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface()

virtual ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::~DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 116 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item & ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 189 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 194 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

getIsocenterToRangeModulatorDistance() [1/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getIsocenterToRangeModulatorDistance	(	DCMTree::TreePtr	item,
		float &	parameter ) const

getIsocenterToRangeModulatorDistance() [2/2]

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

getIsocenterToRangeModulatorDistanceTag()

std::string ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getIsocenterToRangeModulatorDistanceTag ( ) const

inline

Definition at line 120 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTRangeModulatorSettingsSequenceInRTIonBeamsModuleWrapper::getIsocenterToRangeModulatorDistanceTag().

getItem()

DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::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 180 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::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 174 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

getRangeModulatorGatingStartValue() [1/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getRangeModulatorGatingStartValue	(	DCMTree::TreePtr	item,
		float &	parameter ) const

getRangeModulatorGatingStartValue() [2/2]

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

getRangeModulatorGatingStartValueTag()

std::string ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getRangeModulatorGatingStartValueTag ( ) const

inline

Definition at line 126 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTRangeModulatorSettingsSequenceInRTIonBeamsModuleWrapper::getRangeModulatorGatingStartValueTag().

getRangeModulatorGatingStartWaterEquivalentThickness() [1/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getRangeModulatorGatingStartWaterEquivalentThickness	(	DCMTree::TreePtr	item,
		float &	parameter ) const

getRangeModulatorGatingStartWaterEquivalentThickness() [2/2]

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

getRangeModulatorGatingStartWaterEquivalentThicknessTag()

std::string ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getRangeModulatorGatingStartWaterEquivalentThicknessTag ( ) const

inline

Definition at line 132 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTRangeModulatorSettingsSequenceInRTIonBeamsModuleWrapper::getRangeModulatorGatingStartWaterEquivalentThicknessTag().

getRangeModulatorGatingStopValue() [1/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getRangeModulatorGatingStopValue	(	DCMTree::TreePtr	item,
		float &	parameter ) const

getRangeModulatorGatingStopValue() [2/2]

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

getRangeModulatorGatingStopValueTag()

std::string ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getRangeModulatorGatingStopValueTag ( ) const

inline

Definition at line 138 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTRangeModulatorSettingsSequenceInRTIonBeamsModuleWrapper::getRangeModulatorGatingStopValueTag().

getRangeModulatorGatingStopWaterEquivalentThickness() [1/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getRangeModulatorGatingStopWaterEquivalentThickness	(	DCMTree::TreePtr	item,
		float &	parameter ) const

getRangeModulatorGatingStopWaterEquivalentThickness() [2/2]

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

getRangeModulatorGatingStopWaterEquivalentThicknessTag()

std::string ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getRangeModulatorGatingStopWaterEquivalentThicknessTag ( ) const

inline

Definition at line 144 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTRangeModulatorSettingsSequenceInRTIonBeamsModuleWrapper::getRangeModulatorGatingStopWaterEquivalentThicknessTag().

getReferencedRangeModulatorNumber() [1/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getReferencedRangeModulatorNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedRangeModulatorNumber() [2/2]

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

getReferencedRangeModulatorNumberTag()

std::string ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::getReferencedRangeModulatorNumberTag ( ) const

inline

Definition at line 150 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTRangeModulatorSettingsSequenceInRTIonBeamsModuleWrapper::getReferencedRangeModulatorNumberTag().

getSequence()

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

inline

Return the DRTRangeModulatorSettingsSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRangeModulatorSettingsSequenceInRTIonBeamsModule

Definition at line 162 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::hasSequence ( ) const

inline

Check if the DRTRangeModulatorSettingsSequenceInRTIonBeamsModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 168 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

insertItem()

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::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 200 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::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 212 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

setIsocenterToRangeModulatorDistance()

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

setRangeModulatorGatingStartValue()

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

setRangeModulatorGatingStartWaterEquivalentThickness()

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

setRangeModulatorGatingStopValue()

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

setRangeModulatorGatingStopWaterEquivalentThickness()

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

setReferencedRangeModulatorNumber()

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

setSequence()

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

inline

Set the DRTRangeModulatorSettingsSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRangeModulatorSettingsSequenceInRTIonBeamsModule

Definition at line 156 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 224 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h.

---

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

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