ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface Class Reference

Class to provide access to DRTBrachyReferencedDoseReferenceSequence. More...

#include <mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTBrachyReferencedDoseReferenceSequenceInterface (DRTBrachyReferencedDoseReferenceSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTBrachyReferencedDoseReferenceSequenceInterface ()
	Default virtual Destructor.
bool	getCumulativeDoseReferenceCoefficient (unsigned long idx, std::string &parameter)
bool	getCumulativeDoseReferenceCoefficient (DRTBrachyReferencedDoseReferenceSequence::Item &item, std::string &parameter)
std::string	getCumulativeDoseReferenceCoefficientTag () const
bool	setCumulativeDoseReferenceCoefficient (unsigned long idx, std::string &parameter)
bool	getReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter)
bool	getReferencedDoseReferenceNumber (DRTBrachyReferencedDoseReferenceSequence::Item &item, std::string &parameter)
std::string	getReferencedDoseReferenceNumberTag () const
bool	setReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter)
void	setSequence (DRTBrachyReferencedDoseReferenceSequence *dcmSequence)
	Set the DRTBrachyReferencedDoseReferenceSequence this interface class provides access to.
DRTBrachyReferencedDoseReferenceSequence *	getSequence () const
	Return the DRTBrachyReferencedDoseReferenceSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTBrachyReferencedDoseReferenceSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTBrachyReferencedDoseReferenceSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTBrachyReferencedDoseReferenceSequence::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
DRTBrachyReferencedDoseReferenceSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTBrachyReferencedDoseReferenceSequence.

Definition at line 42 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::DcmDRTBrachyReferencedDoseReferenceSequenceInterface

(

DRTBrachyReferencedDoseReferenceSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

virtual ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::~DcmDRTBrachyReferencedDoseReferenceSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

---

Member Function Documentation

DRTBrachyReferencedDoseReferenceSequence::Item* ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::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 mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::getCumulativeDoseReferenceCoefficient	(	DRTBrachyReferencedDoseReferenceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::getCumulativeDoseReferenceCoefficient	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::getCumulativeDoseReferenceCoefficientTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

DRTBrachyReferencedDoseReferenceSequence::Item* ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::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 mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

MLint ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::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 mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::getReferencedDoseReferenceNumber	(	DRTBrachyReferencedDoseReferenceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::getReferencedDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::getReferencedDoseReferenceNumberTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

DRTBrachyReferencedDoseReferenceSequence* ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::getSequence

(

)

const [inline]

Return the DRTBrachyReferencedDoseReferenceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTBrachyReferencedDoseReferenceSequence

Definition at line 71 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTBrachyReferencedDoseReferenceSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 77 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::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 mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::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 mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::setCumulativeDoseReferenceCoefficient	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::setReferencedDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::setSequence

(

DRTBrachyReferencedDoseReferenceSequence *

dcmSequence

)

[inline]

Set the DRTBrachyReferencedDoseReferenceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTBrachyReferencedDoseReferenceSequence

Definition at line 65 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

---

Member Data Documentation

DRTBrachyReferencedDoseReferenceSequence* ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 133 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

---

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

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