ml::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface Class Reference

Class to provide access to DRTBeamLimitingDeviceSequenceInRTImageModule. More...

#include <mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTBeamLimitingDeviceSequenceInRTImageModule.

Definition at line 43 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface() [1/3]

ml::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface ( )

inline

Definition at line 98 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 101 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface() [3/3]

ml::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 103 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

References mlrange_cast().

~DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface()

virtual ml::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::~DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 111 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item & ml::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::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 mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 183 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

References mlrange_cast().

getItem()

DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item ml::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::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 mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

References mlrange_cast().

getLeafJawPositions() [1/2]

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

getLeafJawPositions() [2/2]

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

getLeafJawPositionsTag()

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

inline

Definition at line 115 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

Referenced by DRTBeamLimitingDeviceSequenceInRTImageModuleWrapper::getLeafJawPositionsTag().

getLeafPositionBoundaries() [1/2]

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

getLeafPositionBoundaries() [2/2]

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

getLeafPositionBoundariesTag()

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

inline

Definition at line 121 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

Referenced by DRTBeamLimitingDeviceSequenceInRTImageModuleWrapper::getLeafPositionBoundariesTag().

getNumberOfItems()

MLint ml::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::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 mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

getNumberOfLeafJawPairs() [1/2]

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

getNumberOfLeafJawPairs() [2/2]

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

getNumberOfLeafJawPairsTag()

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

inline

Definition at line 127 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

Referenced by DRTBeamLimitingDeviceSequenceInRTImageModuleWrapper::getNumberOfLeafJawPairsTag().

getRTBeamLimitingDeviceType() [1/2]

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

getRTBeamLimitingDeviceType() [2/2]

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

getRTBeamLimitingDeviceTypeTag()

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

inline

Definition at line 133 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

Referenced by DRTBeamLimitingDeviceSequenceInRTImageModuleWrapper::getRTBeamLimitingDeviceTypeTag().

getSequence()

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

inline

Return the DRTBeamLimitingDeviceSequenceInRTImageModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTBeamLimitingDeviceSequenceInRTImageModule

Definition at line 151 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

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

getSourceToBeamLimitingDeviceDistance() [1/2]

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

getSourceToBeamLimitingDeviceDistance() [2/2]

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

getSourceToBeamLimitingDeviceDistanceTag()

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

inline

Definition at line 139 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

Referenced by DRTBeamLimitingDeviceSequenceInRTImageModuleWrapper::getSourceToBeamLimitingDeviceDistanceTag().

hasSequence()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::hasSequence ( ) const

inline

Check if the DRTBeamLimitingDeviceSequenceInRTImageModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 157 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

insertItem()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::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 mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::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 mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

References mlrange_cast().

setLeafJawPositions()

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

setLeafPositionBoundaries()

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

setNumberOfLeafJawPairs()

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

setRTBeamLimitingDeviceType()

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

setSequence()

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

inline

Set the DRTBeamLimitingDeviceSequenceInRTImageModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTBeamLimitingDeviceSequenceInRTImageModule

Definition at line 145 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

References mlrange_cast().

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

setSourceToBeamLimitingDeviceDistance()

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 213 of file mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h.

---

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

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