ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface Class Reference

Class to provide access to DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModule. More...

#include <mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface ()
	DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface (std::vector< DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface ()
	Default virtual Destructor.
bool	getIsocenterToLateralSpreadingDeviceDistance (unsigned long idx, float &parameter) const
bool	getIsocenterToLateralSpreadingDeviceDistance (DCMTree::TreePtr item, float &parameter) const
std::string	getIsocenterToLateralSpreadingDeviceDistanceTag () const
bool	setIsocenterToLateralSpreadingDeviceDistance (unsigned long idx, float parameter)
bool	getLateralSpreadingDeviceSetting (unsigned long idx, std::string &parameter) const
bool	getLateralSpreadingDeviceSetting (DCMTree::TreePtr item, std::string &parameter) const
std::string	getLateralSpreadingDeviceSettingTag () const
bool	setLateralSpreadingDeviceSetting (unsigned long idx, std::string parameter)
bool	getLateralSpreadingDeviceWaterEquivalentThickness (unsigned long idx, float &parameter) const
bool	getLateralSpreadingDeviceWaterEquivalentThickness (DCMTree::TreePtr item, float &parameter) const
std::string	getLateralSpreadingDeviceWaterEquivalentThicknessTag () const
bool	setLateralSpreadingDeviceWaterEquivalentThickness (unsigned long idx, float parameter)
bool	getReferencedLateralSpreadingDeviceNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedLateralSpreadingDeviceNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedLateralSpreadingDeviceNumberTag () const
bool	setReferencedLateralSpreadingDeviceNumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
std::vector< DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::Item	getItem (const size_t idx) const
DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::Item &	addItem ()
void	addItem (DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModule.

Definition at line 43 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface() [1/3]

ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface ( )

inline

Definition at line 93 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface() [3/3]

ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

~DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface()

virtual ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::~DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::Item & ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::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 mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

getIsocenterToLateralSpreadingDeviceDistance() [1/2]

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getIsocenterToLateralSpreadingDeviceDistance	(	DCMTree::TreePtr	item,
		float &	parameter ) const

getIsocenterToLateralSpreadingDeviceDistance() [2/2]

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getIsocenterToLateralSpreadingDeviceDistance	(	unsigned long	idx,
		float &	parameter ) const

getIsocenterToLateralSpreadingDeviceDistanceTag()

std::string ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getIsocenterToLateralSpreadingDeviceDistanceTag ( ) const

inline

Definition at line 110 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

getItem()

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::Item ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::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 mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

getLateralSpreadingDeviceSetting() [1/2]

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getLateralSpreadingDeviceSetting	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getLateralSpreadingDeviceSetting() [2/2]

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getLateralSpreadingDeviceSetting	(	unsigned long	idx,
		std::string &	parameter ) const

getLateralSpreadingDeviceSettingTag()

std::string ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getLateralSpreadingDeviceSettingTag ( ) const

inline

Definition at line 116 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

getLateralSpreadingDeviceWaterEquivalentThickness() [1/2]

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getLateralSpreadingDeviceWaterEquivalentThickness	(	DCMTree::TreePtr	item,
		float &	parameter ) const

getLateralSpreadingDeviceWaterEquivalentThickness() [2/2]

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getLateralSpreadingDeviceWaterEquivalentThickness	(	unsigned long	idx,
		float &	parameter ) const

getLateralSpreadingDeviceWaterEquivalentThicknessTag()

std::string ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getLateralSpreadingDeviceWaterEquivalentThicknessTag ( ) const

inline

Definition at line 122 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

getNumberOfItems()

MLint ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::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 mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

getReferencedLateralSpreadingDeviceNumber() [1/2]

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getReferencedLateralSpreadingDeviceNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedLateralSpreadingDeviceNumber() [2/2]

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getReferencedLateralSpreadingDeviceNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedLateralSpreadingDeviceNumberTag()

std::string ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::getReferencedLateralSpreadingDeviceNumberTag ( ) const

inline

Definition at line 128 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

getSequence()

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

inline

Return the DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModule

Definition at line 140 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::hasSequence ( ) const

inline

Check if the DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::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 mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::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 mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

setIsocenterToLateralSpreadingDeviceDistance()

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::setIsocenterToLateralSpreadingDeviceDistance	(	unsigned long	idx,
		float	parameter )

setLateralSpreadingDeviceSetting()

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::setLateralSpreadingDeviceSetting	(	unsigned long	idx,
		std::string	parameter )

setLateralSpreadingDeviceWaterEquivalentThickness()

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::setLateralSpreadingDeviceWaterEquivalentThickness	(	unsigned long	idx,
		float	parameter )

setReferencedLateralSpreadingDeviceNumber()

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface::setReferencedLateralSpreadingDeviceNumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModule

Definition at line 134 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface.h.

Referenced by addItem(), addItem(), DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface(), DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

---

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

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