ml::DcmDRTCalculatedDoseReferenceSequenceInterface Class Reference

Class to provide access to DRTCalculatedDoseReferenceSequence. More...

#include <mlDcmDRTCalculatedDoseReferenceSequenceInterface.h>

List of all members.

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

---

Detailed Description

Class to provide access to DRTCalculatedDoseReferenceSequence.

Definition at line 42 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTCalculatedDoseReferenceSequenceInterface::DcmDRTCalculatedDoseReferenceSequenceInterface

(

DRTCalculatedDoseReferenceSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

virtual ml::DcmDRTCalculatedDoseReferenceSequenceInterface::~DcmDRTCalculatedDoseReferenceSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

---

Member Function Documentation

DRTCalculatedDoseReferenceSequence::Item* ml::DcmDRTCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDescription	(	DRTCalculatedDoseReferenceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDescriptionTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDoseValue	(	DRTCalculatedDoseReferenceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDoseValue	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDoseValueTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceNumber	(	DRTCalculatedDoseReferenceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceNumberTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

DRTCalculatedDoseReferenceSequence::Item* ml::DcmDRTCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

MLint ml::DcmDRTCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getReferencedDoseReferenceNumber	(	DRTCalculatedDoseReferenceSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getReferencedDoseReferenceNumberTag

(

)

const [inline]

Definition at line 71 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

DRTCalculatedDoseReferenceSequence* ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getSequence

(

)

const [inline]

Return the DRTCalculatedDoseReferenceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTCalculatedDoseReferenceSequence

Definition at line 83 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTCalculatedDoseReferenceSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 89 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::setCalculatedDoseReferenceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::setCalculatedDoseReferenceDoseValue	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::setCalculatedDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter
	)

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

void ml::DcmDRTCalculatedDoseReferenceSequenceInterface::setSequence

(

DRTCalculatedDoseReferenceSequence *

dcmSequence

)

[inline]

Set the DRTCalculatedDoseReferenceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTCalculatedDoseReferenceSequence

Definition at line 77 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

---

Member Data Documentation

DRTCalculatedDoseReferenceSequence* ml::DcmDRTCalculatedDoseReferenceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 145 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

---

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

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