ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface Class Reference

Class to provide access to DRTBeamLimitingDeviceSequenceInRTIonBeamsModule. More...

#include <mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface ()
	DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface (std::vector< DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface ()
	Default virtual Destructor.
bool	getLeafJawPositions (unsigned long idx, std::string &parameter) const
bool	getLeafJawPositions (DCMTree::TreePtr item, std::string &parameter) const
std::string	getLeafJawPositionsTag () const
bool	setLeafJawPositions (unsigned long idx, std::string parameter)
bool	getLeafPositionBoundaries (unsigned long idx, std::string &parameter) const
bool	getLeafPositionBoundaries (DCMTree::TreePtr item, std::string &parameter) const
std::string	getLeafPositionBoundariesTag () const
bool	setLeafPositionBoundaries (unsigned long idx, std::string parameter)
bool	getNumberOfLeafJawPairs (unsigned long idx, std::string &parameter) const
bool	getNumberOfLeafJawPairs (DCMTree::TreePtr item, std::string &parameter) const
std::string	getNumberOfLeafJawPairsTag () const
bool	setNumberOfLeafJawPairs (unsigned long idx, std::string parameter)
bool	getRTBeamLimitingDeviceType (unsigned long idx, std::string &parameter) const
bool	getRTBeamLimitingDeviceType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRTBeamLimitingDeviceTypeTag () const
bool	setRTBeamLimitingDeviceType (unsigned long idx, std::string parameter)
bool	getSourceToBeamLimitingDeviceDistance (unsigned long idx, std::string &parameter) const
bool	getSourceToBeamLimitingDeviceDistance (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceToBeamLimitingDeviceDistanceTag () const
bool	setSourceToBeamLimitingDeviceDistance (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
std::vector< DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::Item	getItem (const size_t idx) const
DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::Item &	addItem ()
void	addItem (DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTBeamLimitingDeviceSequenceInRTIonBeamsModule.

Definition at line 43 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface() [1/3]

ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface ( )

inline

Definition at line 98 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 101 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface() [3/3]

ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 103 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

~DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface()

virtual ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::~DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 111 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::Item & ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::addItem ( )

inline

Adds a new item to the sequence

Returns

Return the new item which has been added to the sequence

Definition at line 178 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 183 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

getItem()

DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::Item ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::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 169 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

getLeafJawPositions() [1/2]

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getLeafJawPositions	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getLeafJawPositions() [2/2]

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getLeafJawPositions	(	unsigned long	idx,
		std::string &	parameter ) const

getLeafJawPositionsTag()

std::string ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getLeafJawPositionsTag ( ) const

inline

Definition at line 115 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

getLeafPositionBoundaries() [1/2]

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getLeafPositionBoundaries	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getLeafPositionBoundaries() [2/2]

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getLeafPositionBoundaries	(	unsigned long	idx,
		std::string &	parameter ) const

getLeafPositionBoundariesTag()

std::string ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getLeafPositionBoundariesTag ( ) const

inline

Definition at line 121 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

getNumberOfItems()

MLint ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::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 163 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

getNumberOfLeafJawPairs() [1/2]

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getNumberOfLeafJawPairs	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getNumberOfLeafJawPairs() [2/2]

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getNumberOfLeafJawPairs	(	unsigned long	idx,
		std::string &	parameter ) const

getNumberOfLeafJawPairsTag()

std::string ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getNumberOfLeafJawPairsTag ( ) const

inline

Definition at line 127 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

getRTBeamLimitingDeviceType() [1/2]

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getRTBeamLimitingDeviceType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getRTBeamLimitingDeviceType() [2/2]

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getRTBeamLimitingDeviceType	(	unsigned long	idx,
		std::string &	parameter ) const

getRTBeamLimitingDeviceTypeTag()

std::string ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getRTBeamLimitingDeviceTypeTag ( ) const

inline

Definition at line 133 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

getSequence()

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

inline

Return the DRTBeamLimitingDeviceSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTBeamLimitingDeviceSequenceInRTIonBeamsModule

Definition at line 151 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

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

getSourceToBeamLimitingDeviceDistance() [1/2]

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getSourceToBeamLimitingDeviceDistance	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceToBeamLimitingDeviceDistance() [2/2]

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getSourceToBeamLimitingDeviceDistance	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceToBeamLimitingDeviceDistanceTag()

std::string ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::getSourceToBeamLimitingDeviceDistanceTag ( ) const

inline

Definition at line 139 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

hasSequence()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::hasSequence ( ) const

inline

Check if the DRTBeamLimitingDeviceSequenceInRTIonBeamsModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 157 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::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 189 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::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 201 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

setLeafJawPositions()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::setLeafJawPositions	(	unsigned long	idx,
		std::string	parameter )

setLeafPositionBoundaries()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::setLeafPositionBoundaries	(	unsigned long	idx,
		std::string	parameter )

setNumberOfLeafJawPairs()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::setNumberOfLeafJawPairs	(	unsigned long	idx,
		std::string	parameter )

setRTBeamLimitingDeviceType()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::setRTBeamLimitingDeviceType	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTBeamLimitingDeviceSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTBeamLimitingDeviceSequenceInRTIonBeamsModule

Definition at line 145 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

setSourceToBeamLimitingDeviceDistance()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface::setSourceToBeamLimitingDeviceDistance	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 213 of file mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h.

Referenced by addItem(), addItem(), DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface(), DcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface(), 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/mlDcmDRTBeamLimitingDeviceSequenceInRTIonBeamsModuleInterface.h