ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface Class Reference

Class to provide access to DRTReferencedBeamSequenceInRTPlanIOD. More...

#include <mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h>

List of all members.

Public Member Functions

DcmDRTReferencedBeamSequenceInRTPlanIODInterface (DRTReferencedBeamSequenceInRTPlanIOD *_dcmSequence=NULL)

Default Constructor.

virtual ~DcmDRTReferencedBeamSequenceInRTPlanIODInterface ()

Default virtual Destructor.

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

bool getBeamDose (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getBeamDoseTag () const

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

bool getBeamDosePointDepth (unsigned long idx, float &parameter)

bool getBeamDosePointDepth (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, float &parameter)

std::string getBeamDosePointDepthTag () const

bool setBeamDosePointDepth (unsigned long idx, float &parameter)

bool getBeamDosePointEquivalentDepth (unsigned long idx, float &parameter)

bool getBeamDosePointEquivalentDepth (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, float &parameter)

std::string getBeamDosePointEquivalentDepthTag () const

bool setBeamDosePointEquivalentDepth (unsigned long idx, float &parameter)

bool getBeamDosePointSSD (unsigned long idx, float &parameter)

bool getBeamDosePointSSD (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, float &parameter)

std::string getBeamDosePointSSDTag () const

bool setBeamDosePointSSD (unsigned long idx, float &parameter)

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

bool getBeamDoseSpecificationPoint (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getBeamDoseSpecificationPointTag () const

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

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

bool getBeamMeterset (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getBeamMetersetTag () const

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

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

bool getReferencedBeamNumber (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getReferencedBeamNumberTag () const

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

void setSequence (DRTReferencedBeamSequenceInRTPlanIOD *dcmSequence)

Set the DRTReferencedBeamSequenceInRTPlanIOD this interface class provides access to.

DRTReferencedBeamSequenceInRTPlanIOD * getSequence () const

Return the DRTReferencedBeamSequenceInRTPlanIOD this interface class provides access to.

bool hasSequence () const

Check if the DRTReferencedBeamSequenceInRTPlanIOD is set.

MLint getNumberOfItems () const

Return number of items the internal sequence consists of.

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

Return number of items the internal sequence consists of.

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

DRTReferencedBeamSequenceInRTPlanIOD * _dcmSequence

Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTReferencedBeamSequenceInRTPlanIOD.

Definition at line 42 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::DcmDRTReferencedBeamSequenceInRTPlanIODInterface ( DRTReferencedBeamSequenceInRTPlanIOD * _dcmSequence = NULL ) [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

Member Function Documentation

DRTReferencedBeamSequenceInRTPlanIOD::Item* ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::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 131 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDose	(	DRTReferencedBeamSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDose	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDosePointDepth	(	DRTReferencedBeamSequenceInRTPlanIOD::Item &	item,
		float &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDosePointDepth	(	unsigned long	idx,
		float &	parameter
	)

std::string ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDosePointDepthTag ( ) const [inline]

Definition at line 59 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDosePointEquivalentDepth	(	DRTReferencedBeamSequenceInRTPlanIOD::Item &	item,
		float &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDosePointEquivalentDepth	(	unsigned long	idx,
		float &	parameter
	)

std::string ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDosePointEquivalentDepthTag ( ) const [inline]

Definition at line 65 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDosePointSSD	(	DRTReferencedBeamSequenceInRTPlanIOD::Item &	item,
		float &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDosePointSSD	(	unsigned long	idx,
		float &	parameter
	)

std::string ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDosePointSSDTag ( ) const [inline]

Definition at line 71 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDoseSpecificationPoint	(	DRTReferencedBeamSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDoseSpecificationPoint	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDoseSpecificationPointTag ( ) const [inline]

Definition at line 77 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

std::string ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamDoseTag ( ) const [inline]

Definition at line 53 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamMeterset	(	DRTReferencedBeamSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamMeterset	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getBeamMetersetTag ( ) const [inline]

Definition at line 83 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

DRTReferencedBeamSequenceInRTPlanIOD::Item* ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::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 122 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

MLint ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::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 113 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getReferencedBeamNumber	(	DRTReferencedBeamSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getReferencedBeamNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getReferencedBeamNumberTag ( ) const [inline]

Definition at line 89 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

DRTReferencedBeamSequenceInRTPlanIOD* ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::getSequence ( ) const [inline]

Return the DRTReferencedBeamSequenceInRTPlanIOD this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTReferencedBeamSequenceInRTPlanIOD

Definition at line 101 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

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

Check if the DRTReferencedBeamSequenceInRTPlanIOD is set.

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

Definition at line 107 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::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 142 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::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 153 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::setBeamDose	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::setBeamDosePointDepth	(	unsigned long	idx,
		float &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::setBeamDosePointEquivalentDepth	(	unsigned long	idx,
		float &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::setBeamDosePointSSD	(	unsigned long	idx,
		float &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::setBeamDoseSpecificationPoint	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::setBeamMeterset	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::setReferencedBeamNumber	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::setSequence ( DRTReferencedBeamSequenceInRTPlanIOD * dcmSequence ) [inline]

Set the DRTReferencedBeamSequenceInRTPlanIOD this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTReferencedBeamSequenceInRTPlanIOD

Definition at line 95 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

Member Data Documentation

DRTReferencedBeamSequenceInRTPlanIOD* ml::DcmDRTReferencedBeamSequenceInRTPlanIODInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 163 of file mlDcmDRTReferencedBeamSequenceInRTPlanIODInterface.h.

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

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


Public Member Functions
	DcmDRTReferencedBeamSequenceInRTPlanIODInterface (DRTReferencedBeamSequenceInRTPlanIOD *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTReferencedBeamSequenceInRTPlanIODInterface ()
	Default virtual Destructor.
bool	getBeamDose (unsigned long idx, std::string &parameter)
bool	getBeamDose (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getBeamDoseTag () const
bool	setBeamDose (unsigned long idx, std::string &parameter)
bool	getBeamDosePointDepth (unsigned long idx, float &parameter)
bool	getBeamDosePointDepth (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, float &parameter)
std::string	getBeamDosePointDepthTag () const
bool	setBeamDosePointDepth (unsigned long idx, float &parameter)
bool	getBeamDosePointEquivalentDepth (unsigned long idx, float &parameter)
bool	getBeamDosePointEquivalentDepth (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, float &parameter)
std::string	getBeamDosePointEquivalentDepthTag () const
bool	setBeamDosePointEquivalentDepth (unsigned long idx, float &parameter)
bool	getBeamDosePointSSD (unsigned long idx, float &parameter)
bool	getBeamDosePointSSD (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, float &parameter)
std::string	getBeamDosePointSSDTag () const
bool	setBeamDosePointSSD (unsigned long idx, float &parameter)
bool	getBeamDoseSpecificationPoint (unsigned long idx, std::string &parameter)
bool	getBeamDoseSpecificationPoint (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getBeamDoseSpecificationPointTag () const
bool	setBeamDoseSpecificationPoint (unsigned long idx, std::string &parameter)
bool	getBeamMeterset (unsigned long idx, std::string &parameter)
bool	getBeamMeterset (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getBeamMetersetTag () const
bool	setBeamMeterset (unsigned long idx, std::string &parameter)
bool	getReferencedBeamNumber (unsigned long idx, std::string &parameter)
bool	getReferencedBeamNumber (DRTReferencedBeamSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getReferencedBeamNumberTag () const
bool	setReferencedBeamNumber (unsigned long idx, std::string &parameter)
void	setSequence (DRTReferencedBeamSequenceInRTPlanIOD *dcmSequence)
	Set the DRTReferencedBeamSequenceInRTPlanIOD this interface class provides access to.
DRTReferencedBeamSequenceInRTPlanIOD *	getSequence () const
	Return the DRTReferencedBeamSequenceInRTPlanIOD this interface class provides access to.
bool	hasSequence () const
	Check if the DRTReferencedBeamSequenceInRTPlanIOD is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTReferencedBeamSequenceInRTPlanIOD::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTReferencedBeamSequenceInRTPlanIOD::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
DRTReferencedBeamSequenceInRTPlanIOD *	_dcmSequence
	Reference to the wrapped DcmSequence.