ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface Class Reference

Class to provide access to DRTRangeShifterSettingsSequenceInRTIonBeamsModule. More...

#include <mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface ()
	DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface (std::vector< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface ()
	Default virtual Destructor.
bool	getIsocenterToRangeShifterDistance (unsigned long idx, float &parameter) const
bool	getIsocenterToRangeShifterDistance (DCMTree::TreePtr item, float &parameter) const
std::string	getIsocenterToRangeShifterDistanceTag () const
bool	setIsocenterToRangeShifterDistance (unsigned long idx, float parameter)
bool	getRangeShifterSetting (unsigned long idx, std::string &parameter) const
bool	getRangeShifterSetting (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRangeShifterSettingTag () const
bool	setRangeShifterSetting (unsigned long idx, std::string parameter)
bool	getRangeShifterWaterEquivalentThickness (unsigned long idx, float &parameter) const
bool	getRangeShifterWaterEquivalentThickness (DCMTree::TreePtr item, float &parameter) const
std::string	getRangeShifterWaterEquivalentThicknessTag () const
bool	setRangeShifterWaterEquivalentThickness (unsigned long idx, float parameter)
bool	getReferencedRangeShifterNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedRangeShifterNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedRangeShifterNumberTag () const
bool	setReferencedRangeShifterNumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
	Set the DRTRangeShifterSettingsSequenceInRTIonBeamsModule this interface class provides access to.
std::vector< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item >	getSequence () const
	Return the DRTRangeShifterSettingsSequenceInRTIonBeamsModule this interface class provides access to.
bool	hasSequence () const
	Check if the DRTRangeShifterSettingsSequenceInRTIonBeamsModule is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::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< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTRangeShifterSettingsSequenceInRTIonBeamsModule.

Definition at line 43 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface() [1/3]

ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface ( )

inline

Definition at line 93 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface() [3/3]

ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

~DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface()

virtual ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::~DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item & ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 167 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

getIsocenterToRangeShifterDistance() [1/2]

bool ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::getIsocenterToRangeShifterDistance	(	DCMTree::TreePtr	item,
		float &	parameter ) const

getIsocenterToRangeShifterDistance() [2/2]

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

getIsocenterToRangeShifterDistanceTag()

std::string ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::getIsocenterToRangeShifterDistanceTag ( ) const

inline

Definition at line 110 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTRangeShifterSettingsSequenceInRTIonBeamsModuleWrapper::getIsocenterToRangeShifterDistanceTag().

getItem()

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::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 158 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::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 152 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

getRangeShifterSetting() [1/2]

bool ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::getRangeShifterSetting	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getRangeShifterSetting() [2/2]

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

getRangeShifterSettingTag()

std::string ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::getRangeShifterSettingTag ( ) const

inline

Definition at line 116 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTRangeShifterSettingsSequenceInRTIonBeamsModuleWrapper::getRangeShifterSettingTag().

getRangeShifterWaterEquivalentThickness() [1/2]

bool ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::getRangeShifterWaterEquivalentThickness	(	DCMTree::TreePtr	item,
		float &	parameter ) const

getRangeShifterWaterEquivalentThickness() [2/2]

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

getRangeShifterWaterEquivalentThicknessTag()

std::string ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::getRangeShifterWaterEquivalentThicknessTag ( ) const

inline

Definition at line 122 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTRangeShifterSettingsSequenceInRTIonBeamsModuleWrapper::getRangeShifterWaterEquivalentThicknessTag().

getReferencedRangeShifterNumber() [1/2]

bool ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::getReferencedRangeShifterNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedRangeShifterNumber() [2/2]

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

getReferencedRangeShifterNumberTag()

std::string ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::getReferencedRangeShifterNumberTag ( ) const

inline

Definition at line 128 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTRangeShifterSettingsSequenceInRTIonBeamsModuleWrapper::getReferencedRangeShifterNumberTag().

getSequence()

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

inline

Return the DRTRangeShifterSettingsSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRangeShifterSettingsSequenceInRTIonBeamsModule

Definition at line 140 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::hasSequence ( ) const

inline

Check if the DRTRangeShifterSettingsSequenceInRTIonBeamsModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

insertItem()

bool ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::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 178 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::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 190 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

setIsocenterToRangeShifterDistance()

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

setRangeShifterSetting()

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

setRangeShifterWaterEquivalentThickness()

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

setReferencedRangeShifterNumber()

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

setSequence()

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

inline

Set the DRTRangeShifterSettingsSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRangeShifterSettingsSequenceInRTIonBeamsModule

Definition at line 134 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h.

---

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

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