ml::DcmDRTRTROIObservationsSequenceInterface Class Reference

Class to provide access to DRTRTROIObservationsSequence. More...

#include <mlDcmDRTRTROIObservationsSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTRTROIObservationsSequenceInterface (DRTRTROIObservationsSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTRTROIObservationsSequenceInterface ()
	Default virtual Destructor.
bool	getMaterialID (unsigned long idx, std::string &parameter)
bool	getMaterialID (DRTRTROIObservationsSequence::Item &item, std::string &parameter)
std::string	getMaterialIDTag () const
bool	setMaterialID (unsigned long idx, std::string &parameter)
bool	getObservationNumber (unsigned long idx, std::string &parameter)
bool	getObservationNumber (DRTRTROIObservationsSequence::Item &item, std::string &parameter)
std::string	getObservationNumberTag () const
bool	setObservationNumber (unsigned long idx, std::string &parameter)
bool	getROIInterpreter (unsigned long idx, std::string &parameter)
bool	getROIInterpreter (DRTRTROIObservationsSequence::Item &item, std::string &parameter)
std::string	getROIInterpreterTag () const
bool	setROIInterpreter (unsigned long idx, std::string &parameter)
bool	getROIObservationDescription (unsigned long idx, std::string &parameter)
bool	getROIObservationDescription (DRTRTROIObservationsSequence::Item &item, std::string &parameter)
std::string	getROIObservationDescriptionTag () const
bool	setROIObservationDescription (unsigned long idx, std::string &parameter)
bool	getROIObservationLabel (unsigned long idx, std::string &parameter)
bool	getROIObservationLabel (DRTRTROIObservationsSequence::Item &item, std::string &parameter)
std::string	getROIObservationLabelTag () const
bool	setROIObservationLabel (unsigned long idx, std::string &parameter)
bool	getRTROIInterpretedType (unsigned long idx, std::string &parameter)
bool	getRTROIInterpretedType (DRTRTROIObservationsSequence::Item &item, std::string &parameter)
std::string	getRTROIInterpretedTypeTag () const
bool	setRTROIInterpretedType (unsigned long idx, std::string &parameter)
bool	getReferencedROINumber (unsigned long idx, std::string &parameter)
bool	getReferencedROINumber (DRTRTROIObservationsSequence::Item &item, std::string &parameter)
std::string	getReferencedROINumberTag () const
bool	setReferencedROINumber (unsigned long idx, std::string &parameter)
DRTROIPhysicalPropertiesSequence &	getROIPhysicalPropertiesSequence (unsigned long idx)
std::string	getROIPhysicalPropertiesSequenceTag () const
DRTRTROIIdentificationCodeSequence &	getRTROIIdentificationCodeSequence (unsigned long idx)
std::string	getRTROIIdentificationCodeSequenceTag () const
DRTRTRelatedROISequence &	getRTRelatedROISequence (unsigned long idx)
std::string	getRTRelatedROISequenceTag () const
DRTRelatedRTROIObservationsSequence &	getRelatedRTROIObservationsSequence (unsigned long idx)
std::string	getRelatedRTROIObservationsSequenceTag () const
void	setSequence (DRTRTROIObservationsSequence *dcmSequence)
	Set the DRTRTROIObservationsSequence this interface class provides access to.
DRTRTROIObservationsSequence *	getSequence () const
	Return the DRTRTROIObservationsSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTRTROIObservationsSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTRTROIObservationsSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTRTROIObservationsSequence::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
DRTRTROIObservationsSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTRTROIObservationsSequence.

Definition at line 46 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTRTROIObservationsSequenceInterface::DcmDRTRTROIObservationsSequenceInterface

(

DRTRTROIObservationsSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 50 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

virtual ml::DcmDRTRTROIObservationsSequenceInterface::~DcmDRTRTROIObservationsSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 53 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

---

Member Function Documentation

DRTRTROIObservationsSequence::Item* ml::DcmDRTRTROIObservationsSequenceInterface::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 151 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

DRTRTROIObservationsSequence::Item* ml::DcmDRTRTROIObservationsSequenceInterface::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 142 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::getMaterialID	(	DRTRTROIObservationsSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRTROIObservationsSequenceInterface::getMaterialID	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getMaterialIDTag

(

)

const [inline]

Definition at line 57 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

MLint ml::DcmDRTRTROIObservationsSequenceInterface::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 133 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::getObservationNumber	(	DRTRTROIObservationsSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRTROIObservationsSequenceInterface::getObservationNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getObservationNumberTag

(

)

const [inline]

Definition at line 63 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::getReferencedROINumber	(	DRTRTROIObservationsSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getReferencedROINumberTag

(

)

const [inline]

Definition at line 93 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

DRTRelatedRTROIObservationsSequence& ml::DcmDRTRTROIObservationsSequenceInterface::getRelatedRTROIObservationsSequence

(

unsigned long

idx

)

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getRelatedRTROIObservationsSequenceTag

(

)

const [inline]

Definition at line 110 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::getROIInterpreter	(	DRTRTROIObservationsSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRTROIObservationsSequenceInterface::getROIInterpreter	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getROIInterpreterTag

(

)

const [inline]

Definition at line 69 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::getROIObservationDescription	(	DRTRTROIObservationsSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRTROIObservationsSequenceInterface::getROIObservationDescription	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getROIObservationDescriptionTag

(

)

const [inline]

Definition at line 75 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::getROIObservationLabel	(	DRTRTROIObservationsSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRTROIObservationsSequenceInterface::getROIObservationLabel	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getROIObservationLabelTag

(

)

const [inline]

Definition at line 81 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

DRTROIPhysicalPropertiesSequence& ml::DcmDRTRTROIObservationsSequenceInterface::getROIPhysicalPropertiesSequence

(

unsigned long

idx

)

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getROIPhysicalPropertiesSequenceTag

(

)

const [inline]

Definition at line 98 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

DRTRTRelatedROISequence& ml::DcmDRTRTROIObservationsSequenceInterface::getRTRelatedROISequence

(

unsigned long

idx

)

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getRTRelatedROISequenceTag

(

)

const [inline]

Definition at line 106 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

DRTRTROIIdentificationCodeSequence& ml::DcmDRTRTROIObservationsSequenceInterface::getRTROIIdentificationCodeSequence

(

unsigned long

idx

)

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getRTROIIdentificationCodeSequenceTag

(

)

const [inline]

Definition at line 102 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::getRTROIInterpretedType	(	DRTRTROIObservationsSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRTROIObservationsSequenceInterface::getRTROIInterpretedType	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getRTROIInterpretedTypeTag

(

)

const [inline]

Definition at line 87 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

DRTRTROIObservationsSequence* ml::DcmDRTRTROIObservationsSequenceInterface::getSequence

(

)

const [inline]

Return the DRTRTROIObservationsSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRTROIObservationsSequence

Definition at line 121 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTRTROIObservationsSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 127 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::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 162 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::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 173 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

bool ml::DcmDRTRTROIObservationsSequenceInterface::setMaterialID	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRTROIObservationsSequenceInterface::setObservationNumber	(	unsigned long	idx,
		std::string &	parameter
	)

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

bool ml::DcmDRTRTROIObservationsSequenceInterface::setROIInterpreter	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRTROIObservationsSequenceInterface::setROIObservationDescription	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRTROIObservationsSequenceInterface::setROIObservationLabel	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRTROIObservationsSequenceInterface::setRTROIInterpretedType	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTRTROIObservationsSequenceInterface::setSequence

(

DRTRTROIObservationsSequence *

dcmSequence

)

[inline]

Set the DRTRTROIObservationsSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRTROIObservationsSequence

Definition at line 115 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

---

Member Data Documentation

DRTRTROIObservationsSequence* ml::DcmDRTRTROIObservationsSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 183 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

---

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

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