ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface Class Reference

Class to provide access to DRTReferencedBeamSequenceInRTDoseIOD. More...

#include <mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h>

List of all members.

Public Member Functions
	DcmDRTReferencedBeamSequenceInRTDoseIODInterface (DRTReferencedBeamSequenceInRTDoseIOD *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTReferencedBeamSequenceInRTDoseIODInterface ()
	Default virtual Destructor.
bool	getReferencedBeamNumber (unsigned long idx, std::string &parameter)
bool	getReferencedBeamNumber (DRTReferencedBeamSequenceInRTDoseIOD::Item &item, std::string &parameter)
std::string	getReferencedBeamNumberTag () const
bool	setReferencedBeamNumber (unsigned long idx, std::string &parameter)
bool	getReferencedBrachyApplicationSetupNumber (unsigned long idx, std::string &parameter)
bool	getReferencedBrachyApplicationSetupNumber (DRTReferencedBeamSequenceInRTDoseIOD::Item &item, std::string &parameter)
std::string	getReferencedBrachyApplicationSetupNumberTag () const
bool	setReferencedBrachyApplicationSetupNumber (unsigned long idx, std::string &parameter)
DRTReferencedControlPointSequence &	getReferencedControlPointSequence (unsigned long idx)
std::string	getReferencedControlPointSequenceTag () const
void	setSequence (DRTReferencedBeamSequenceInRTDoseIOD *dcmSequence)
	Set the DRTReferencedBeamSequenceInRTDoseIOD this interface class provides access to.
DRTReferencedBeamSequenceInRTDoseIOD *	getSequence () const
	Return the DRTReferencedBeamSequenceInRTDoseIOD this interface class provides access to.
bool	hasSequence () const
	Check if the DRTReferencedBeamSequenceInRTDoseIOD is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTReferencedBeamSequenceInRTDoseIOD::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTReferencedBeamSequenceInRTDoseIOD::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
DRTReferencedBeamSequenceInRTDoseIOD *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTReferencedBeamSequenceInRTDoseIOD.

Definition at line 43 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::DcmDRTReferencedBeamSequenceInRTDoseIODInterface

(

DRTReferencedBeamSequenceInRTDoseIOD *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 47 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

virtual ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::~DcmDRTReferencedBeamSequenceInRTDoseIODInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 50 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

---

Member Function Documentation

DRTReferencedBeamSequenceInRTDoseIOD::Item* ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::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 106 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

DRTReferencedBeamSequenceInRTDoseIOD::Item* ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::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 97 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

MLint ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::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 88 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::getReferencedBeamNumber	(	DRTReferencedBeamSequenceInRTDoseIOD::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::getReferencedBeamNumberTag

(

)

const [inline]

Definition at line 54 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::getReferencedBrachyApplicationSetupNumber	(	DRTReferencedBeamSequenceInRTDoseIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::getReferencedBrachyApplicationSetupNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::getReferencedBrachyApplicationSetupNumberTag

(

)

const [inline]

Definition at line 60 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

DRTReferencedControlPointSequence& ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::getReferencedControlPointSequence

(

unsigned long

idx

)

std::string ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::getReferencedControlPointSequenceTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

DRTReferencedBeamSequenceInRTDoseIOD* ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::getSequence

(

)

const [inline]

Return the DRTReferencedBeamSequenceInRTDoseIOD this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTReferencedBeamSequenceInRTDoseIOD

Definition at line 76 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::hasSequence

(

)

const [inline]

Check if the DRTReferencedBeamSequenceInRTDoseIOD is set.

Returns:

True if internal pointer is set, False else.

Definition at line 82 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::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 117 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

bool ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::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 128 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

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

bool ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::setReferencedBrachyApplicationSetupNumber	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::setSequence

(

DRTReferencedBeamSequenceInRTDoseIOD *

dcmSequence

)

[inline]

Set the DRTReferencedBeamSequenceInRTDoseIOD this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTReferencedBeamSequenceInRTDoseIOD

Definition at line 70 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

---

Member Data Documentation

DRTReferencedBeamSequenceInRTDoseIOD* ml::DcmDRTReferencedBeamSequenceInRTDoseIODInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 138 of file mlDcmDRTReferencedBeamSequenceInRTDoseIODInterface.h.

---

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

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