ml::DcmDRTRTROIObservationsSequenceInterface Class Reference

Class to provide access to DRTRTROIObservationsSequence. More...

#include <mlDcmDRTRTROIObservationsSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTRTROIObservationsSequenceInterface ()
	DcmDRTRTROIObservationsSequenceInterface (std::vector< DcmDRTRTROIObservationsSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTRTROIObservationsSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTRTROIObservationsSequenceInterface ()
	Default virtual Destructor.
bool	getMaterialID (unsigned long idx, std::string &parameter) const
bool	getMaterialID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getMaterialIDTag () const
bool	setMaterialID (unsigned long idx, std::string parameter)
bool	getObservationNumber (unsigned long idx, std::string &parameter) const
bool	getObservationNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getObservationNumberTag () const
bool	setObservationNumber (unsigned long idx, std::string parameter)
bool	getROIInterpreter (unsigned long idx, std::string &parameter) const
bool	getROIInterpreter (DCMTree::TreePtr item, std::string &parameter) const
std::string	getROIInterpreterTag () const
bool	setROIInterpreter (unsigned long idx, std::string parameter)
bool	getROIObservationDescription (unsigned long idx, std::string &parameter) const
bool	getROIObservationDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string	getROIObservationDescriptionTag () const
bool	setROIObservationDescription (unsigned long idx, std::string parameter)
bool	getROIObservationLabel (unsigned long idx, std::string &parameter) const
bool	getROIObservationLabel (DCMTree::TreePtr item, std::string &parameter) const
std::string	getROIObservationLabelTag () const
bool	setROIObservationLabel (unsigned long idx, std::string parameter)
bool	getRTROIInterpretedType (unsigned long idx, std::string &parameter) const
bool	getRTROIInterpretedType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRTROIInterpretedTypeTag () const
bool	setRTROIInterpretedType (unsigned long idx, std::string parameter)
bool	getReferencedROINumber (unsigned long idx, std::string &parameter) const
bool	getReferencedROINumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedROINumberTag () const
bool	setReferencedROINumber (unsigned long idx, std::string parameter)
DcmDRTROIPhysicalPropertiesSequenceInterface	getROIPhysicalPropertiesSequence (unsigned long idx) const
std::string	getROIPhysicalPropertiesSequenceTag () const
void	setROIPhysicalPropertiesSequence (DcmDRTROIPhysicalPropertiesSequenceInterface seq, unsigned long idx)
DcmDRTRTROIIdentificationCodeSequenceInterface	getRTROIIdentificationCodeSequence (unsigned long idx) const
std::string	getRTROIIdentificationCodeSequenceTag () const
void	setRTROIIdentificationCodeSequence (DcmDRTRTROIIdentificationCodeSequenceInterface seq, unsigned long idx)
DcmDRTRTRelatedROISequenceInterface	getRTRelatedROISequence (unsigned long idx) const
std::string	getRTRelatedROISequenceTag () const
void	setRTRelatedROISequence (DcmDRTRTRelatedROISequenceInterface seq, unsigned long idx)
DcmDRTRelatedRTROIObservationsSequenceInterface	getRelatedRTROIObservationsSequence (unsigned long idx) const
std::string	getRelatedRTROIObservationsSequenceTag () const
void	setRelatedRTROIObservationsSequence (DcmDRTRelatedRTROIObservationsSequenceInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTRTROIObservationsSequenceInterface::Item > dcmSequence)
	Set the DRTRTROIObservationsSequence this interface class provides access to.
std::vector< DcmDRTRTROIObservationsSequenceInterface::Item >	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.
DcmDRTRTROIObservationsSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTRTROIObservationsSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTRTROIObservationsSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
	Insert an item at the indicated position.
bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence.

Protected Attributes
std::vector< DcmDRTRTROIObservationsSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTRTROIObservationsSequence.

Definition at line 47 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTRTROIObservationsSequenceInterface() [1/3]

ml::DcmDRTRTROIObservationsSequenceInterface::DcmDRTRTROIObservationsSequenceInterface ( )

inline

Definition at line 132 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

DcmDRTRTROIObservationsSequenceInterface() [2/3]

ml::DcmDRTRTROIObservationsSequenceInterface::DcmDRTRTROIObservationsSequenceInterface ( std::vector< DcmDRTRTROIObservationsSequenceInterface::Item >  dcmSequence )

inline

Default Constructor.

Definition at line 135 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

DcmDRTRTROIObservationsSequenceInterface() [3/3]

ml::DcmDRTRTROIObservationsSequenceInterface::DcmDRTRTROIObservationsSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 137 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

~DcmDRTRTROIObservationsSequenceInterface()

virtual ml::DcmDRTRTROIObservationsSequenceInterface::~DcmDRTRTROIObservationsSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 145 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTRTROIObservationsSequenceInterface::Item & ml::DcmDRTRTROIObservationsSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 244 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

addItem() [2/2]

void ml::DcmDRTRTROIObservationsSequenceInterface::addItem ( DcmDRTRTROIObservationsSequenceInterface::Item  newItem )

inline

Definition at line 249 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

getItem()

DcmDRTRTROIObservationsSequenceInterface::Item ml::DcmDRTRTROIObservationsSequenceInterface::getItem ( const size_t  idx ) const

inline

Gets the item at the indicated position.

Returns

The requested item, an empty item when the position is invalid

Definition at line 235 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

getMaterialID() [1/2]

bool ml::DcmDRTRTROIObservationsSequenceInterface::getMaterialID	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getMaterialID() [2/2]

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

getMaterialIDTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getMaterialIDTag ( ) const

inline

Definition at line 149 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getMaterialIDTag().

getNumberOfItems()

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 229 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

getObservationNumber() [1/2]

bool ml::DcmDRTRTROIObservationsSequenceInterface::getObservationNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getObservationNumber() [2/2]

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

getObservationNumberTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getObservationNumberTag ( ) const

inline

Definition at line 155 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getObservationNumberTag().

getReferencedROINumber() [1/2]

bool ml::DcmDRTRTROIObservationsSequenceInterface::getReferencedROINumber	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getReferencedROINumber() [2/2]

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

getReferencedROINumberTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getReferencedROINumberTag ( ) const

inline

Definition at line 185 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getReferencedROINumberTag().

getRelatedRTROIObservationsSequence()

DcmDRTRelatedRTROIObservationsSequenceInterface ml::DcmDRTRTROIObservationsSequenceInterface::getRelatedRTROIObservationsSequence

(

unsigned long

idx

)

const

getRelatedRTROIObservationsSequenceTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getRelatedRTROIObservationsSequenceTag ( ) const

inline

Definition at line 205 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getRelatedRTROIObservationsSequenceTag().

getROIInterpreter() [1/2]

bool ml::DcmDRTRTROIObservationsSequenceInterface::getROIInterpreter	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getROIInterpreter() [2/2]

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

getROIInterpreterTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getROIInterpreterTag ( ) const

inline

Definition at line 161 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getROIInterpreterTag().

getROIObservationDescription() [1/2]

bool ml::DcmDRTRTROIObservationsSequenceInterface::getROIObservationDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getROIObservationDescription() [2/2]

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

getROIObservationDescriptionTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getROIObservationDescriptionTag ( ) const

inline

Definition at line 167 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getROIObservationDescriptionTag().

getROIObservationLabel() [1/2]

bool ml::DcmDRTRTROIObservationsSequenceInterface::getROIObservationLabel	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getROIObservationLabel() [2/2]

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

getROIObservationLabelTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getROIObservationLabelTag ( ) const

inline

Definition at line 173 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getROIObservationLabelTag().

getROIPhysicalPropertiesSequence()

DcmDRTROIPhysicalPropertiesSequenceInterface ml::DcmDRTRTROIObservationsSequenceInterface::getROIPhysicalPropertiesSequence

(

unsigned long

idx

)

const

getROIPhysicalPropertiesSequenceTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getROIPhysicalPropertiesSequenceTag ( ) const

inline

Definition at line 190 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getROIPhysicalPropertiesSequenceTag().

getRTRelatedROISequence()

DcmDRTRTRelatedROISequenceInterface ml::DcmDRTRTROIObservationsSequenceInterface::getRTRelatedROISequence

(

unsigned long

idx

)

const

getRTRelatedROISequenceTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getRTRelatedROISequenceTag ( ) const

inline

Definition at line 200 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getRTRelatedROISequenceTag().

getRTROIIdentificationCodeSequence()

DcmDRTRTROIIdentificationCodeSequenceInterface ml::DcmDRTRTROIObservationsSequenceInterface::getRTROIIdentificationCodeSequence

(

unsigned long

idx

)

const

getRTROIIdentificationCodeSequenceTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getRTROIIdentificationCodeSequenceTag ( ) const

inline

Definition at line 195 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getRTROIIdentificationCodeSequenceTag().

getRTROIInterpretedType() [1/2]

bool ml::DcmDRTRTROIObservationsSequenceInterface::getRTROIInterpretedType	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getRTROIInterpretedType() [2/2]

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

getRTROIInterpretedTypeTag()

std::string ml::DcmDRTRTROIObservationsSequenceInterface::getRTROIInterpretedTypeTag ( ) const

inline

Definition at line 179 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::getRTROIInterpretedTypeTag().

getSequence()

std::vector< DcmDRTRTROIObservationsSequenceInterface::Item > ml::DcmDRTRTROIObservationsSequenceInterface::getSequence ( ) const

inline

Return the DRTRTROIObservationsSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRTROIObservationsSequence

Definition at line 217 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::DRTRTROIObservationsSequenceWrapper(), and DRTRTROIObservationsSequenceWrapper::operator=().

hasSequence()

bool ml::DcmDRTRTROIObservationsSequenceInterface::hasSequence ( ) const

inline

Check if the DRTRTROIObservationsSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 223 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

insertItem()

bool ml::DcmDRTRTROIObservationsSequenceInterface::insertItem ( const size_t  idx )

inline

Insert an item at the indicated position.

Returns

true is the insertion was successful, false if position is invalid

Definition at line 255 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

removeItem()

bool ml::DcmDRTRTROIObservationsSequenceInterface::removeItem ( const size_t  idx )

inline

Removes the indicated item from the sequence.

Returns

true if the item was deleted successfully, false if the indicated position is invalid

Definition at line 267 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

setMaterialID()

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

setObservationNumber()

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

setReferencedROINumber()

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

setRelatedRTROIObservationsSequence()

void ml::DcmDRTRTROIObservationsSequenceInterface::setRelatedRTROIObservationsSequence	(	DcmDRTRelatedRTROIObservationsSequenceInterface	seq,
		unsigned long	idx
	)

setROIInterpreter()

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

setROIObservationDescription()

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

setROIObservationLabel()

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

setROIPhysicalPropertiesSequence()

void ml::DcmDRTRTROIObservationsSequenceInterface::setROIPhysicalPropertiesSequence	(	DcmDRTROIPhysicalPropertiesSequenceInterface	seq,
		unsigned long	idx
	)

setRTRelatedROISequence()

void ml::DcmDRTRTROIObservationsSequenceInterface::setRTRelatedROISequence	(	DcmDRTRTRelatedROISequenceInterface	seq,
		unsigned long	idx
	)

setRTROIIdentificationCodeSequence()

void ml::DcmDRTRTROIObservationsSequenceInterface::setRTROIIdentificationCodeSequence	(	DcmDRTRTROIIdentificationCodeSequenceInterface	seq,
		unsigned long	idx
	)

setRTROIInterpretedType()

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

setSequence()

void ml::DcmDRTRTROIObservationsSequenceInterface::setSequence ( std::vector< DcmDRTRTROIObservationsSequenceInterface::Item >  dcmSequence )

inline

Set the DRTRTROIObservationsSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRTROIObservationsSequence

Definition at line 211 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

Referenced by DRTRTROIObservationsSequenceWrapper::DRTRTROIObservationsSequenceWrapper(), and DRTRTROIObservationsSequenceWrapper::operator=().

Member Data Documentation

_itemVec

std::vector<DcmDRTRTROIObservationsSequenceInterface::Item> ml::DcmDRTRTROIObservationsSequenceInterface::_itemVec

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 279 of file mlDcmDRTRTROIObservationsSequenceInterface.h.

---

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

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