ml::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface Class Reference

Class to provide access to DRTBeamLimitingDeviceSequenceInRTBeamsModule. More...

#include <mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface ()
	DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface (std::vector< DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface ()
	Default virtual Destructor.
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< DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::Item > dcmSequence)
std::vector< DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::Item	getItem (const size_t idx) const
DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::Item &	addItem ()
void	addItem (DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTBeamLimitingDeviceSequenceInRTBeamsModule.

Definition at line 43 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface() [1/3]

ml::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface ( )

inline

Definition at line 93 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface() [3/3]

ml::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

~DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface()

virtual ml::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::~DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::Item & ml::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::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 mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

getItem()

DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::Item ml::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::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 mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

getLeafPositionBoundaries() [1/2]

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

getLeafPositionBoundaries() [2/2]

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

getLeafPositionBoundariesTag()

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

inline

Definition at line 110 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

getNumberOfItems()

MLint ml::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::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 mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

getNumberOfLeafJawPairs() [1/2]

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

getNumberOfLeafJawPairs() [2/2]

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

getNumberOfLeafJawPairsTag()

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

inline

Definition at line 116 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

getRTBeamLimitingDeviceType() [1/2]

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

getRTBeamLimitingDeviceType() [2/2]

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

getRTBeamLimitingDeviceTypeTag()

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

inline

Definition at line 122 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

getSequence()

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

inline

Return the DRTBeamLimitingDeviceSequenceInRTBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTBeamLimitingDeviceSequenceInRTBeamsModule

Definition at line 140 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

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

getSourceToBeamLimitingDeviceDistance() [1/2]

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

getSourceToBeamLimitingDeviceDistance() [2/2]

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

getSourceToBeamLimitingDeviceDistanceTag()

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

inline

Definition at line 128 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

hasSequence()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::hasSequence ( ) const

inline

Check if the DRTBeamLimitingDeviceSequenceInRTBeamsModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::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 mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface::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 mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

setLeafPositionBoundaries()

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

setNumberOfLeafJawPairs()

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

setRTBeamLimitingDeviceType()

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

setSequence()

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

inline

Set the DRTBeamLimitingDeviceSequenceInRTBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTBeamLimitingDeviceSequenceInRTBeamsModule

Definition at line 134 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

References _itemVec.

setSourceToBeamLimitingDeviceDistance()

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface.h.

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