ml::DcmDRTBeamLimitingDevicePositionSequenceInterface Class Reference

Class to provide access to DRTBeamLimitingDevicePositionSequence. More...

#include <mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTBeamLimitingDevicePositionSequence.

Definition at line 43 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTBeamLimitingDevicePositionSequenceInterface() [1/3]

ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::DcmDRTBeamLimitingDevicePositionSequenceInterface ( )

inline

Definition at line 83 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

DcmDRTBeamLimitingDevicePositionSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

DcmDRTBeamLimitingDevicePositionSequenceInterface() [3/3]

ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::DcmDRTBeamLimitingDevicePositionSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

~DcmDRTBeamLimitingDevicePositionSequenceInterface()

virtual ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::~DcmDRTBeamLimitingDevicePositionSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTBeamLimitingDevicePositionSequenceInterface::Item & ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::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 mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

getItem()

DcmDRTBeamLimitingDevicePositionSequenceInterface::Item ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::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 mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

getLeafJawPositions() [1/2]

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

getLeafJawPositions() [2/2]

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

getLeafJawPositionsTag()

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

inline

Definition at line 100 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

Referenced by DRTBeamLimitingDevicePositionSequenceWrapper::getLeafJawPositionsTag().

getNumberOfItems()

MLint ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::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 mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

getRTBeamLimitingDeviceType() [1/2]

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

getRTBeamLimitingDeviceType() [2/2]

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

getRTBeamLimitingDeviceTypeTag()

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

inline

Definition at line 106 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

Referenced by DRTBeamLimitingDevicePositionSequenceWrapper::getRTBeamLimitingDeviceTypeTag().

getSequence()

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

inline

Return the DRTBeamLimitingDevicePositionSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTBeamLimitingDevicePositionSequence

Definition at line 118 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::hasSequence ( ) const

inline

Check if the DRTBeamLimitingDevicePositionSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

insertItem()

bool ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::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 mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

removeItem()

bool ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::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 mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

setLeafJawPositions()

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

setRTBeamLimitingDeviceType()

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

setSequence()

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

inline

Set the DRTBeamLimitingDevicePositionSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTBeamLimitingDevicePositionSequence

Definition at line 112 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

---

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

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