ml::DcmDRTRTDoseROISequenceInterface Class Reference

Class to provide access to DRTRTDoseROISequence. More...

#include <mlDcmDRTRTDoseROISequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTRTDoseROISequenceInterface (DRTRTDoseROISequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTRTDoseROISequenceInterface ()
	Default virtual Destructor.
bool	getDoseUnits (unsigned long idx, std::string &parameter)
bool	getDoseUnits (DRTRTDoseROISequence::Item &item, std::string &parameter)
std::string	getDoseUnitsTag () const
bool	setDoseUnits (unsigned long idx, std::string &parameter)
bool	getDoseValue (unsigned long idx, std::string &parameter)
bool	getDoseValue (DRTRTDoseROISequence::Item &item, std::string &parameter)
std::string	getDoseValueTag () const
bool	setDoseValue (unsigned long idx, std::string &parameter)
bool	getReferencedROINumber (unsigned long idx, std::string &parameter)
bool	getReferencedROINumber (DRTRTDoseROISequence::Item &item, std::string &parameter)
std::string	getReferencedROINumberTag () const
bool	setReferencedROINumber (unsigned long idx, std::string &parameter)
void	setSequence (DRTRTDoseROISequence *dcmSequence)
	Set the DRTRTDoseROISequence this interface class provides access to.
DRTRTDoseROISequence *	getSequence () const
	Return the DRTRTDoseROISequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTRTDoseROISequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTRTDoseROISequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTRTDoseROISequence::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
DRTRTDoseROISequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTRTDoseROISequence.

Definition at line 42 of file mlDcmDRTRTDoseROISequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTRTDoseROISequenceInterface::DcmDRTRTDoseROISequenceInterface

(

DRTRTDoseROISequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTRTDoseROISequenceInterface.h.

virtual ml::DcmDRTRTDoseROISequenceInterface::~DcmDRTRTDoseROISequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTRTDoseROISequenceInterface.h.

---

Member Function Documentation

DRTRTDoseROISequence::Item* ml::DcmDRTRTDoseROISequenceInterface::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 107 of file mlDcmDRTRTDoseROISequenceInterface.h.

bool ml::DcmDRTRTDoseROISequenceInterface::getDoseUnits	(	DRTRTDoseROISequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRTDoseROISequenceInterface::getDoseUnits	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRTDoseROISequenceInterface::getDoseUnitsTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTRTDoseROISequenceInterface.h.

bool ml::DcmDRTRTDoseROISequenceInterface::getDoseValue	(	DRTRTDoseROISequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRTDoseROISequenceInterface::getDoseValue	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRTDoseROISequenceInterface::getDoseValueTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTRTDoseROISequenceInterface.h.

DRTRTDoseROISequence::Item* ml::DcmDRTRTDoseROISequenceInterface::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 98 of file mlDcmDRTRTDoseROISequenceInterface.h.

MLint ml::DcmDRTRTDoseROISequenceInterface::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 89 of file mlDcmDRTRTDoseROISequenceInterface.h.

bool ml::DcmDRTRTDoseROISequenceInterface::getReferencedROINumber	(	DRTRTDoseROISequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRTDoseROISequenceInterface::getReferencedROINumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRTDoseROISequenceInterface::getReferencedROINumberTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTRTDoseROISequenceInterface.h.

DRTRTDoseROISequence* ml::DcmDRTRTDoseROISequenceInterface::getSequence

(

)

const [inline]

Return the DRTRTDoseROISequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRTDoseROISequence

Definition at line 77 of file mlDcmDRTRTDoseROISequenceInterface.h.

bool ml::DcmDRTRTDoseROISequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTRTDoseROISequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 83 of file mlDcmDRTRTDoseROISequenceInterface.h.

bool ml::DcmDRTRTDoseROISequenceInterface::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 118 of file mlDcmDRTRTDoseROISequenceInterface.h.

bool ml::DcmDRTRTDoseROISequenceInterface::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 129 of file mlDcmDRTRTDoseROISequenceInterface.h.

bool ml::DcmDRTRTDoseROISequenceInterface::setDoseUnits	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRTDoseROISequenceInterface::setDoseValue	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRTDoseROISequenceInterface::setReferencedROINumber	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTRTDoseROISequenceInterface::setSequence

(

DRTRTDoseROISequence *

dcmSequence

)

[inline]

Set the DRTRTDoseROISequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRTDoseROISequence

Definition at line 71 of file mlDcmDRTRTDoseROISequenceInterface.h.

---

Member Data Documentation

DRTRTDoseROISequence* ml::DcmDRTRTDoseROISequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 139 of file mlDcmDRTRTDoseROISequenceInterface.h.

---

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

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