ml::DcmDRTReferencedDoseSequenceInterface Class Reference

Class to provide access to DRTReferencedDoseSequence. More...

#include <mlDcmDRTReferencedDoseSequenceInterface.h>

List of all members.

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

---

Detailed Description

Class to provide access to DRTReferencedDoseSequence.

Definition at line 42 of file mlDcmDRTReferencedDoseSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTReferencedDoseSequenceInterface::DcmDRTReferencedDoseSequenceInterface

(

DRTReferencedDoseSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTReferencedDoseSequenceInterface.h.

virtual ml::DcmDRTReferencedDoseSequenceInterface::~DcmDRTReferencedDoseSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTReferencedDoseSequenceInterface.h.

---

Member Function Documentation

DRTReferencedDoseSequence::Item* ml::DcmDRTReferencedDoseSequenceInterface::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 mlDcmDRTReferencedDoseSequenceInterface.h.

DRTReferencedDoseSequence::Item* ml::DcmDRTReferencedDoseSequenceInterface::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 mlDcmDRTReferencedDoseSequenceInterface.h.

MLint ml::DcmDRTReferencedDoseSequenceInterface::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 mlDcmDRTReferencedDoseSequenceInterface.h.

bool ml::DcmDRTReferencedDoseSequenceInterface::getReferencedSOPClassUID	(	DRTReferencedDoseSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedDoseSequenceInterface::getReferencedSOPClassUID	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTReferencedDoseSequenceInterface::getReferencedSOPClassUIDTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTReferencedDoseSequenceInterface.h.

bool ml::DcmDRTReferencedDoseSequenceInterface::getReferencedSOPInstanceUID	(	DRTReferencedDoseSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedDoseSequenceInterface::getReferencedSOPInstanceUID	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTReferencedDoseSequenceInterface::getReferencedSOPInstanceUIDTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTReferencedDoseSequenceInterface.h.

DRTReferencedDoseSequence* ml::DcmDRTReferencedDoseSequenceInterface::getSequence

(

)

const [inline]

Return the DRTReferencedDoseSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTReferencedDoseSequence

Definition at line 71 of file mlDcmDRTReferencedDoseSequenceInterface.h.

bool ml::DcmDRTReferencedDoseSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTReferencedDoseSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 77 of file mlDcmDRTReferencedDoseSequenceInterface.h.

bool ml::DcmDRTReferencedDoseSequenceInterface::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 mlDcmDRTReferencedDoseSequenceInterface.h.

bool ml::DcmDRTReferencedDoseSequenceInterface::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 mlDcmDRTReferencedDoseSequenceInterface.h.

bool ml::DcmDRTReferencedDoseSequenceInterface::setReferencedSOPClassUID	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTReferencedDoseSequenceInterface::setReferencedSOPInstanceUID	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTReferencedDoseSequenceInterface::setSequence

(

DRTReferencedDoseSequence *

dcmSequence

)

[inline]

Set the DRTReferencedDoseSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTReferencedDoseSequence

Definition at line 65 of file mlDcmDRTReferencedDoseSequenceInterface.h.

---

Member Data Documentation

DRTReferencedDoseSequence* ml::DcmDRTReferencedDoseSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 133 of file mlDcmDRTReferencedDoseSequenceInterface.h.

---

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

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