ml::DcmDRTMeasuredDoseReferenceSequenceInterface Class Reference

Class to provide access to DRTMeasuredDoseReferenceSequence. More...

#include <mlDcmDRTMeasuredDoseReferenceSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTMeasuredDoseReferenceSequenceInterface ()
	DcmDRTMeasuredDoseReferenceSequenceInterface (std::vector< DcmDRTMeasuredDoseReferenceSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTMeasuredDoseReferenceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTMeasuredDoseReferenceSequenceInterface ()
	Default virtual Destructor.
bool	getDoseUnits (unsigned long idx, std::string &parameter) const
bool	getDoseUnits (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDoseUnitsTag () const
bool	setDoseUnits (unsigned long idx, std::string parameter)
bool	getMeasuredDoseDescription (unsigned long idx, std::string &parameter) const
bool	getMeasuredDoseDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string	getMeasuredDoseDescriptionTag () const
bool	setMeasuredDoseDescription (unsigned long idx, std::string parameter)
bool	getMeasuredDoseReferenceNumber (unsigned long idx, std::string &parameter) const
bool	getMeasuredDoseReferenceNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getMeasuredDoseReferenceNumberTag () const
bool	setMeasuredDoseReferenceNumber (unsigned long idx, std::string parameter)
bool	getMeasuredDoseType (unsigned long idx, std::string &parameter) const
bool	getMeasuredDoseType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getMeasuredDoseTypeTag () const
bool	setMeasuredDoseType (unsigned long idx, std::string parameter)
bool	getMeasuredDoseValue (unsigned long idx, std::string &parameter) const
bool	getMeasuredDoseValue (DCMTree::TreePtr item, std::string &parameter) const
std::string	getMeasuredDoseValueTag () const
bool	setMeasuredDoseValue (unsigned long idx, std::string parameter)
bool	getReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedDoseReferenceNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedDoseReferenceNumberTag () const
bool	setReferencedDoseReferenceNumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTMeasuredDoseReferenceSequenceInterface::Item > dcmSequence)
	Set the DRTMeasuredDoseReferenceSequence this interface class provides access to.
std::vector< DcmDRTMeasuredDoseReferenceSequenceInterface::Item >	getSequence () const
	Return the DRTMeasuredDoseReferenceSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTMeasuredDoseReferenceSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTMeasuredDoseReferenceSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTMeasuredDoseReferenceSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTMeasuredDoseReferenceSequenceInterface::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< DcmDRTMeasuredDoseReferenceSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTMeasuredDoseReferenceSequence.

Definition at line 43 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTMeasuredDoseReferenceSequenceInterface() [1/3]

ml::DcmDRTMeasuredDoseReferenceSequenceInterface::DcmDRTMeasuredDoseReferenceSequenceInterface ( )

inline

Definition at line 103 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

DcmDRTMeasuredDoseReferenceSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 106 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

DcmDRTMeasuredDoseReferenceSequenceInterface() [3/3]

ml::DcmDRTMeasuredDoseReferenceSequenceInterface::DcmDRTMeasuredDoseReferenceSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 108 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

~DcmDRTMeasuredDoseReferenceSequenceInterface()

virtual ml::DcmDRTMeasuredDoseReferenceSequenceInterface::~DcmDRTMeasuredDoseReferenceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 116 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTMeasuredDoseReferenceSequenceInterface::Item & ml::DcmDRTMeasuredDoseReferenceSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 189 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 194 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

getDoseUnits() [1/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getDoseUnits	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getDoseUnits() [2/2]

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

getDoseUnitsTag()

std::string ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getDoseUnitsTag ( ) const

inline

Definition at line 120 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getDoseUnitsTag().

getItem()

DcmDRTMeasuredDoseReferenceSequenceInterface::Item ml::DcmDRTMeasuredDoseReferenceSequenceInterface::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 180 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

getMeasuredDoseDescription() [1/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getMeasuredDoseDescription() [2/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseDescription	(	unsigned long	idx,
		std::string &	parameter
	)		const

getMeasuredDoseDescriptionTag()

std::string ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseDescriptionTag ( ) const

inline

Definition at line 126 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getMeasuredDoseDescriptionTag().

getMeasuredDoseReferenceNumber() [1/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseReferenceNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getMeasuredDoseReferenceNumber() [2/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter
	)		const

getMeasuredDoseReferenceNumberTag()

std::string ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseReferenceNumberTag ( ) const

inline

Definition at line 132 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getMeasuredDoseReferenceNumberTag().

getMeasuredDoseType() [1/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseType	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getMeasuredDoseType() [2/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseType	(	unsigned long	idx,
		std::string &	parameter
	)		const

getMeasuredDoseTypeTag()

std::string ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseTypeTag ( ) const

inline

Definition at line 138 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getMeasuredDoseTypeTag().

getMeasuredDoseValue() [1/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseValue	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getMeasuredDoseValue() [2/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseValue	(	unsigned long	idx,
		std::string &	parameter
	)		const

getMeasuredDoseValueTag()

std::string ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getMeasuredDoseValueTag ( ) const

inline

Definition at line 144 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getMeasuredDoseValueTag().

getNumberOfItems()

MLint ml::DcmDRTMeasuredDoseReferenceSequenceInterface::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 174 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

getReferencedDoseReferenceNumber() [1/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getReferencedDoseReferenceNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getReferencedDoseReferenceNumber() [2/2]

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getReferencedDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter
	)		const

getReferencedDoseReferenceNumberTag()

std::string ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getReferencedDoseReferenceNumberTag ( ) const

inline

Definition at line 150 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getReferencedDoseReferenceNumberTag().

getSequence()

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

inline

Return the DRTMeasuredDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTMeasuredDoseReferenceSequence

Definition at line 162 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTMeasuredDoseReferenceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 168 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

insertItem()

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::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 200 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

removeItem()

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::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 212 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

setDoseUnits()

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

setMeasuredDoseDescription()

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::setMeasuredDoseDescription	(	unsigned long	idx,
		std::string	parameter
	)

setMeasuredDoseReferenceNumber()

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::setMeasuredDoseReferenceNumber	(	unsigned long	idx,
		std::string	parameter
	)

setMeasuredDoseType()

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::setMeasuredDoseType	(	unsigned long	idx,
		std::string	parameter
	)

setMeasuredDoseValue()

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::setMeasuredDoseValue	(	unsigned long	idx,
		std::string	parameter
	)

setReferencedDoseReferenceNumber()

bool ml::DcmDRTMeasuredDoseReferenceSequenceInterface::setReferencedDoseReferenceNumber	(	unsigned long	idx,
		std::string	parameter
	)

setSequence()

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

inline

Set the DRTMeasuredDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTMeasuredDoseReferenceSequence

Definition at line 156 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 224 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

---

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

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