ml::DcmDRTIonBeamLimitingDeviceSequenceInterface Class Reference

Class to provide access to DRTIonBeamLimitingDeviceSequence. More...

#include <mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h>

List of all members.

Public Member Functions

DcmDRTIonBeamLimitingDeviceSequenceInterface (DRTIonBeamLimitingDeviceSequence *_dcmSequence=NULL)

Default Constructor.

virtual ~DcmDRTIonBeamLimitingDeviceSequenceInterface ()

Default virtual Destructor.

bool getIsocenterToBeamLimitingDeviceDistance (unsigned long idx, float &parameter)

bool getIsocenterToBeamLimitingDeviceDistance (DRTIonBeamLimitingDeviceSequence::Item &item, float &parameter)

std::string getIsocenterToBeamLimitingDeviceDistanceTag () const

bool setIsocenterToBeamLimitingDeviceDistance (unsigned long idx, float &parameter)

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

bool getLeafPositionBoundaries (DRTIonBeamLimitingDeviceSequence::Item &item, std::string &parameter)

std::string getLeafPositionBoundariesTag () const

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

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

bool getNumberOfLeafJawPairs (DRTIonBeamLimitingDeviceSequence::Item &item, std::string &parameter)

std::string getNumberOfLeafJawPairsTag () const

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

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

bool getRTBeamLimitingDeviceType (DRTIonBeamLimitingDeviceSequence::Item &item, std::string &parameter)

std::string getRTBeamLimitingDeviceTypeTag () const

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

void setSequence (DRTIonBeamLimitingDeviceSequence *dcmSequence)

Set the DRTIonBeamLimitingDeviceSequence this interface class provides access to.

DRTIonBeamLimitingDeviceSequence * 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.

DRTIonBeamLimitingDeviceSequence::Item * getItem (const unsigned long idx)

Return number of items the internal sequence consists of.

DRTIonBeamLimitingDeviceSequence::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

DRTIonBeamLimitingDeviceSequence * _dcmSequence

Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTIonBeamLimitingDeviceSequence.

Definition at line 42 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::DcmDRTIonBeamLimitingDeviceSequenceInterface ( DRTIonBeamLimitingDeviceSequence * _dcmSequence = NULL ) [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

virtual ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::~DcmDRTIonBeamLimitingDeviceSequenceInterface ( ) [inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

Member Function Documentation

DRTIonBeamLimitingDeviceSequence::Item* ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::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 113 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getIsocenterToBeamLimitingDeviceDistance	(	DRTIonBeamLimitingDeviceSequence::Item &	item,
		float &	parameter
	)

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

std::string ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getIsocenterToBeamLimitingDeviceDistanceTag ( ) const [inline]

Definition at line 53 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

DRTIonBeamLimitingDeviceSequence::Item* ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::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 104 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getLeafPositionBoundaries	(	DRTIonBeamLimitingDeviceSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getLeafPositionBoundariesTag ( ) const [inline]

Definition at line 59 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

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 95 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getNumberOfLeafJawPairs	(	DRTIonBeamLimitingDeviceSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getNumberOfLeafJawPairsTag ( ) const [inline]

Definition at line 65 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getRTBeamLimitingDeviceType	(	DRTIonBeamLimitingDeviceSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getRTBeamLimitingDeviceTypeTag ( ) const [inline]

Definition at line 71 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

DRTIonBeamLimitingDeviceSequence* ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::getSequence ( ) const [inline]

Return the DRTIonBeamLimitingDeviceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTIonBeamLimitingDeviceSequence

Definition at line 83 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

bool ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::hasSequence ( ) const [inline]

Check if the DRTIonBeamLimitingDeviceSequence is set.

Returns:: True if internal pointer is set, False else.

Definition at line 89 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

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

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

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

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

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

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

void ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::setSequence ( DRTIonBeamLimitingDeviceSequence * dcmSequence ) [inline]

Set the DRTIonBeamLimitingDeviceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTIonBeamLimitingDeviceSequence

Definition at line 77 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

Member Data Documentation

DRTIonBeamLimitingDeviceSequence* ml::DcmDRTIonBeamLimitingDeviceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 145 of file mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h.

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

FMEwork/Release/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTIonBeamLimitingDeviceSequenceInterface.h


Public Member Functions
	DcmDRTIonBeamLimitingDeviceSequenceInterface (DRTIonBeamLimitingDeviceSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTIonBeamLimitingDeviceSequenceInterface ()
	Default virtual Destructor.
bool	getIsocenterToBeamLimitingDeviceDistance (unsigned long idx, float &parameter)
bool	getIsocenterToBeamLimitingDeviceDistance (DRTIonBeamLimitingDeviceSequence::Item &item, float &parameter)
std::string	getIsocenterToBeamLimitingDeviceDistanceTag () const
bool	setIsocenterToBeamLimitingDeviceDistance (unsigned long idx, float &parameter)
bool	getLeafPositionBoundaries (unsigned long idx, std::string &parameter)
bool	getLeafPositionBoundaries (DRTIonBeamLimitingDeviceSequence::Item &item, std::string &parameter)
std::string	getLeafPositionBoundariesTag () const
bool	setLeafPositionBoundaries (unsigned long idx, std::string &parameter)
bool	getNumberOfLeafJawPairs (unsigned long idx, std::string &parameter)
bool	getNumberOfLeafJawPairs (DRTIonBeamLimitingDeviceSequence::Item &item, std::string &parameter)
std::string	getNumberOfLeafJawPairsTag () const
bool	setNumberOfLeafJawPairs (unsigned long idx, std::string &parameter)
bool	getRTBeamLimitingDeviceType (unsigned long idx, std::string &parameter)
bool	getRTBeamLimitingDeviceType (DRTIonBeamLimitingDeviceSequence::Item &item, std::string &parameter)
std::string	getRTBeamLimitingDeviceTypeTag () const
bool	setRTBeamLimitingDeviceType (unsigned long idx, std::string &parameter)
void	setSequence (DRTIonBeamLimitingDeviceSequence *dcmSequence)
	Set the DRTIonBeamLimitingDeviceSequence this interface class provides access to.
DRTIonBeamLimitingDeviceSequence *	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.
DRTIonBeamLimitingDeviceSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTIonBeamLimitingDeviceSequence::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
DRTIonBeamLimitingDeviceSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.