ml::DcmDRTBeamLimitingDevicePositionSequenceInterface Class Reference

Class to provide access to DRTBeamLimitingDevicePositionSequence. More...

#include <mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTBeamLimitingDevicePositionSequenceInterface (DRTBeamLimitingDevicePositionSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTBeamLimitingDevicePositionSequenceInterface ()
	Default virtual Destructor.
bool	getLeafJawPositions (unsigned long idx, std::string &parameter)
bool	getLeafJawPositions (DRTBeamLimitingDevicePositionSequence::Item &item, std::string &parameter)
std::string	getLeafJawPositionsTag () const
bool	setLeafJawPositions (unsigned long idx, std::string &parameter)
bool	getRTBeamLimitingDeviceType (unsigned long idx, std::string &parameter)
bool	getRTBeamLimitingDeviceType (DRTBeamLimitingDevicePositionSequence::Item &item, std::string &parameter)
std::string	getRTBeamLimitingDeviceTypeTag () const
bool	setRTBeamLimitingDeviceType (unsigned long idx, std::string &parameter)
void	setSequence (DRTBeamLimitingDevicePositionSequence *dcmSequence)
	Set the DRTBeamLimitingDevicePositionSequence this interface class provides access to.
DRTBeamLimitingDevicePositionSequence *	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.
DRTBeamLimitingDevicePositionSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTBeamLimitingDevicePositionSequence::Item *	addItem ()
	Return number of items the internal sequence consists of.
bool	insertItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
bool	removeItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
Protected Attributes
DRTBeamLimitingDevicePositionSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTBeamLimitingDevicePositionSequence.

Definition at line 42 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::DcmDRTBeamLimitingDevicePositionSequenceInterface

(

DRTBeamLimitingDevicePositionSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

virtual ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::~DcmDRTBeamLimitingDevicePositionSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

---

Member Function Documentation

DRTBeamLimitingDevicePositionSequence::Item* ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::addItem

(

)

[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 101 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

DRTBeamLimitingDevicePositionSequence::Item* ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::getItem

(

const unsigned long

idx

)

[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 92 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

bool ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::getLeafJawPositions	(	DRTBeamLimitingDevicePositionSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::getLeafJawPositionsTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

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 83 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

bool ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::getRTBeamLimitingDeviceType	(	DRTBeamLimitingDevicePositionSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::getRTBeamLimitingDeviceTypeTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

DRTBeamLimitingDevicePositionSequence* ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::getSequence

(

)

const [inline]

Return the DRTBeamLimitingDevicePositionSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTBeamLimitingDevicePositionSequence

Definition at line 71 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

bool ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTBeamLimitingDevicePositionSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 77 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

bool ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::insertItem

(

const unsigned long

idx

)

[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 112 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

bool ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::removeItem

(

const unsigned long

idx

)

[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 123 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

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

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

void ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::setSequence

(

DRTBeamLimitingDevicePositionSequence *

dcmSequence

)

[inline]

Set the DRTBeamLimitingDevicePositionSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTBeamLimitingDevicePositionSequence

Definition at line 65 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

---

Member Data Documentation

DRTBeamLimitingDevicePositionSequence* ml::DcmDRTBeamLimitingDevicePositionSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 133 of file mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h.

---

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

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