ml::DcmDRTDVHReferencedROISequenceInterface Class Reference

Class to provide access to DRTDVHReferencedROISequence. More...

#include <mlDcmDRTDVHReferencedROISequenceInterface.h>

List of all members.

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

---

Detailed Description

Class to provide access to DRTDVHReferencedROISequence.

Definition at line 42 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTDVHReferencedROISequenceInterface::DcmDRTDVHReferencedROISequenceInterface

(

DRTDVHReferencedROISequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

virtual ml::DcmDRTDVHReferencedROISequenceInterface::~DcmDRTDVHReferencedROISequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

---

Member Function Documentation

DRTDVHReferencedROISequence::Item* ml::DcmDRTDVHReferencedROISequenceInterface::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 mlDcmDRTDVHReferencedROISequenceInterface.h.

bool ml::DcmDRTDVHReferencedROISequenceInterface::getDVHROIContributionType	(	DRTDVHReferencedROISequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDVHReferencedROISequenceInterface::getDVHROIContributionType	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDVHReferencedROISequenceInterface::getDVHROIContributionTypeTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

DRTDVHReferencedROISequence::Item* ml::DcmDRTDVHReferencedROISequenceInterface::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 mlDcmDRTDVHReferencedROISequenceInterface.h.

MLint ml::DcmDRTDVHReferencedROISequenceInterface::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 mlDcmDRTDVHReferencedROISequenceInterface.h.

bool ml::DcmDRTDVHReferencedROISequenceInterface::getReferencedROINumber	(	DRTDVHReferencedROISequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTDVHReferencedROISequenceInterface::getReferencedROINumberTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

DRTDVHReferencedROISequence* ml::DcmDRTDVHReferencedROISequenceInterface::getSequence

(

)

const [inline]

Return the DRTDVHReferencedROISequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTDVHReferencedROISequence

Definition at line 71 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

bool ml::DcmDRTDVHReferencedROISequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTDVHReferencedROISequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 77 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

bool ml::DcmDRTDVHReferencedROISequenceInterface::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 mlDcmDRTDVHReferencedROISequenceInterface.h.

bool ml::DcmDRTDVHReferencedROISequenceInterface::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 mlDcmDRTDVHReferencedROISequenceInterface.h.

bool ml::DcmDRTDVHReferencedROISequenceInterface::setDVHROIContributionType	(	unsigned long	idx,
		std::string &	parameter
	)

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

void ml::DcmDRTDVHReferencedROISequenceInterface::setSequence

(

DRTDVHReferencedROISequence *

dcmSequence

)

[inline]

Set the DRTDVHReferencedROISequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTDVHReferencedROISequence

Definition at line 65 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

---

Member Data Documentation

DRTDVHReferencedROISequence* ml::DcmDRTDVHReferencedROISequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 133 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

---

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

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