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. More...

	DcmDRTMeasuredDoseReferenceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)

virtual	~DcmDRTMeasuredDoseReferenceSequenceInterface ()
	Default virtual Destructor. More...

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. More...

std::vector< DcmDRTMeasuredDoseReferenceSequenceInterface::Item * >	getSequence () const
	Return the DRTMeasuredDoseReferenceSequence this interface class provides access to. More...

bool	hasSequence () const
	Check if the DRTMeasuredDoseReferenceSequence is set. More...

MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of. More...

const DcmDRTMeasuredDoseReferenceSequenceInterface::Item *	getItem (const size_t idx) const
	Gets the item at the indicated position. More...

DcmDRTMeasuredDoseReferenceSequenceInterface::Item *	getItem (const size_t idx)
	Gets the item at the indicated position. More...

DcmDRTMeasuredDoseReferenceSequenceInterface::Item *	addItem ()
	Adds a new item to the sequence. More...

void	addItem (DcmDRTMeasuredDoseReferenceSequenceInterface::Item *newItem)

bool	insertItem (const size_t idx)
	Insert an item at the indicated position. More...

bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence. More...

Protected Attributes
std::vector< DcmDRTMeasuredDoseReferenceSequenceInterface::Item * >	_itemPtrVec
	Reference to the wrapped DICOM tree pointer vector. More...

Detailed Description

Class to provide access to DRTMeasuredDoseReferenceSequence.

Definition at line 46 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTMeasuredDoseReferenceSequenceInterface::DcmDRTMeasuredDoseReferenceSequenceInterface ( )

inline

Definition at line 102 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

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

inline

Default Constructor.

Definition at line 105 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

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

inline

Definition at line 107 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

virtual ml::DcmDRTMeasuredDoseReferenceSequenceInterface::~DcmDRTMeasuredDoseReferenceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 116 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Member Function Documentation

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 198 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

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

inline

Definition at line 204 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

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

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

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

inline

Definition at line 120 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getDoseUnitsTag().

const 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.

DcmDRTMeasuredDoseReferenceSequenceInterface::Item* ml::DcmDRTMeasuredDoseReferenceSequenceInterface::getItem ( const size_t idx )

inline

Gets the item at the indicated position.

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

Definition at line 189 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

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

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

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

inline

Definition at line 126 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getMeasuredDoseDescriptionTag().

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

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

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

inline

Definition at line 132 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getMeasuredDoseReferenceNumberTag().

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

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

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

inline

Definition at line 138 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getMeasuredDoseTypeTag().

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

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

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

inline

Definition at line 144 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getMeasuredDoseValueTag().

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.

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

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

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

inline

Definition at line 150 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

Referenced by DRTMeasuredDoseReferenceSequenceWrapper::getReferencedDoseReferenceNumberTag().

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=().

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.

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 210 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

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 223 of file mlDcmDRTMeasuredDoseReferenceSequenceInterface.h.

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

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

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

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

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

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

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=().