ml::DcmDRTIonBeamLimitingDeviceSequenceInterface Class Reference

Class to provide access to DRTIonBeamLimitingDeviceSequence. More...

#include <mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTIonBeamLimitingDeviceSequence.

Definition at line 43 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTIonBeamLimitingDeviceSequenceInterface() [1/3]

ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::DcmDRTIonBeamLimitingDeviceSequenceInterface ( )

inline

Definition at line 93 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

DcmDRTIonBeamLimitingDeviceSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

DcmDRTIonBeamLimitingDeviceSequenceInterface() [3/3]

ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::DcmDRTIonBeamLimitingDeviceSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

~DcmDRTIonBeamLimitingDeviceSequenceInterface()

virtual ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::~DcmDRTIonBeamLimitingDeviceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTIonBeamLimitingDeviceSequenceInterface::Item & ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::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 mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

getIsocenterToBeamLimitingDeviceDistance() [1/2]

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getIsocenterToBeamLimitingDeviceDistance	(	DCMTree::TreePtr	item,
		float &	parameter
	)		const

getIsocenterToBeamLimitingDeviceDistance() [2/2]

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getIsocenterToBeamLimitingDeviceDistance	(	unsigned long	idx,
		float &	parameter
	)		const

getIsocenterToBeamLimitingDeviceDistanceTag()

std::string ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getIsocenterToBeamLimitingDeviceDistanceTag ( ) const

inline

Definition at line 110 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

Referenced by DRTIonBeamLimitingDeviceSequenceWrapper::getIsocenterToBeamLimitingDeviceDistanceTag().

getItem()

DcmDRTIonBeamLimitingDeviceSequenceInterface::Item ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::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 mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

getLeafPositionBoundaries() [1/2]

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

getLeafPositionBoundaries() [2/2]

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

getLeafPositionBoundariesTag()

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

inline

Definition at line 116 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

Referenced by DRTIonBeamLimitingDeviceSequenceWrapper::getLeafPositionBoundariesTag().

getNumberOfItems()

MLint ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::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 mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

getNumberOfLeafJawPairs() [1/2]

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

getNumberOfLeafJawPairs() [2/2]

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

getNumberOfLeafJawPairsTag()

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

inline

Definition at line 122 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

Referenced by DRTIonBeamLimitingDeviceSequenceWrapper::getNumberOfLeafJawPairsTag().

getRTBeamLimitingDeviceType() [1/2]

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

getRTBeamLimitingDeviceType() [2/2]

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

getRTBeamLimitingDeviceTypeTag()

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

inline

Definition at line 128 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

Referenced by DRTIonBeamLimitingDeviceSequenceWrapper::getRTBeamLimitingDeviceTypeTag().

getSequence()

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

inline

Return the DRTIonBeamLimitingDeviceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTIonBeamLimitingDeviceSequence

Definition at line 140 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTIonBeamLimitingDeviceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

insertItem()

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::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 mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

removeItem()

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::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 mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

setIsocenterToBeamLimitingDeviceDistance()

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::setIsocenterToBeamLimitingDeviceDistance	(	unsigned long	idx,
		float	parameter
	)

setLeafPositionBoundaries()

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

setNumberOfLeafJawPairs()

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

setRTBeamLimitingDeviceType()

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

setSequence()

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

inline

Set the DRTIonBeamLimitingDeviceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTIonBeamLimitingDeviceSequence

Definition at line 134 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

---

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

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