ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface Class Reference

Class to provide access to DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModule. More...

#include <mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ()
	DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface (std::vector< DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item > dcmSequence)
	Default Constructor. More...
	DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ()
	Default virtual Destructor. More...
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	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< DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item > dcmSequence)
	Set the DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to. More...
std::vector< DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item >	getSequence () const
	Return the DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to. More...
bool	hasSequence () const
	Check if the DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModule is set. More...
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of. More...
DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position. More...
DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item &	addItem ()
	Adds a new item to the sequence. More...
void	addItem (DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
	Insert an item at the indicated position. More...
bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence. More...

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

Detailed Description

Class to provide access to DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModule.

Definition at line 43 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface() [1/3]

ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ( )

inline

Definition at line 83 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface() [3/3]

ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

~DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface()

virtual ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::~DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item& ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

getItem()

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

getLateralSpreadingDeviceSetting() [1/2]

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

getLateralSpreadingDeviceSetting() [2/2]

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

getLateralSpreadingDeviceSettingTag()

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

inline

Definition at line 100 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Referenced by DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleWrapper::getLateralSpreadingDeviceSettingTag().

getNumberOfItems()

MLint ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

getReferencedLateralSpreadingDeviceNumber() [1/2]

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

getReferencedLateralSpreadingDeviceNumber() [2/2]

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

getReferencedLateralSpreadingDeviceNumberTag()

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

inline

Definition at line 106 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Referenced by DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleWrapper::getReferencedLateralSpreadingDeviceNumberTag().

getSequence()

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

inline

Return the DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModule

Definition at line 118 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::hasSequence ( ) const

inline

Check if the DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

insertItem()

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

removeItem()

bool ml::DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

setLateralSpreadingDeviceSetting()

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

setReferencedLateralSpreadingDeviceNumber()

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

setSequence()

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

inline

Set the DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModule

Definition at line 112 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

---

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

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