ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface Class Reference

Class to provide access to DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModule. More...

#include <mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ()
	DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface (std::vector< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ()
	Default virtual Destructor.
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	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< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item > dcmSequence)
	Set the DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.
std::vector< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item >	getSequence () const
	Return the DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.
bool	hasSequence () const
	Check if the DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModule is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModule.

Definition at line 43 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface() [1/3]

ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ( )

inline

Definition at line 83 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface() [3/3]

ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

~DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface()

virtual ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::~DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item & ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 145 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

getItem()

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 136 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 130 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

getRangeShifterSetting() [1/2]

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

getRangeShifterSetting() [2/2]

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

getRangeShifterSettingTag()

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

inline

Definition at line 100 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Referenced by DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleWrapper::getRangeShifterSettingTag().

getReferencedRangeShifterNumber() [1/2]

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

getReferencedRangeShifterNumber() [2/2]

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

getReferencedRangeShifterNumberTag()

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

inline

Definition at line 106 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Referenced by DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleWrapper::getReferencedRangeShifterNumberTag().

getSequence()

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

inline

Return the DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModule

Definition at line 118 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::hasSequence ( ) const

inline

Check if the DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

insertItem()

bool ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 156 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 168 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

setRangeShifterSetting()

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

setReferencedRangeShifterNumber()

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

setSequence()

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

inline

Set the DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModule

Definition at line 112 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

---

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

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