ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface Class Reference

Class to provide access to DRTReferencedMeasuredDoseReferenceSequence. More...

#include <mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTReferencedMeasuredDoseReferenceSequenceInterface ()
	DcmDRTReferencedMeasuredDoseReferenceSequenceInterface (std::vector< DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTReferencedMeasuredDoseReferenceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTReferencedMeasuredDoseReferenceSequenceInterface ()
	Default virtual Destructor.
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)
bool	getReferencedMeasuredDoseReferenceNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedMeasuredDoseReferenceNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedMeasuredDoseReferenceNumberTag () const
bool	setReferencedMeasuredDoseReferenceNumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTReferencedMeasuredDoseReferenceSequence.

Definition at line 43 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedMeasuredDoseReferenceSequenceInterface() [1/3]

ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface ( )

inline

Definition at line 88 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

DcmDRTReferencedMeasuredDoseReferenceSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

DcmDRTReferencedMeasuredDoseReferenceSequenceInterface() [3/3]

ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

~DcmDRTReferencedMeasuredDoseReferenceSequenceInterface()

virtual ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::~DcmDRTReferencedMeasuredDoseReferenceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::Item & ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::addItem ( )

inline

Adds a new item to the sequence

Returns

Return the new item which has been added to the sequence

Definition at line 156 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

getItem()

DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::Item ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::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 147 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

getMeasuredDoseValue() [1/2]

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

getMeasuredDoseValue() [2/2]

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

getMeasuredDoseValueTag()

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

inline

Definition at line 105 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

getNumberOfItems()

MLint ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::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 141 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

getReferencedDoseReferenceNumber() [1/2]

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

getReferencedDoseReferenceNumber() [2/2]

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

getReferencedDoseReferenceNumberTag()

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

inline

Definition at line 111 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

getReferencedMeasuredDoseReferenceNumber() [1/2]

bool ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::getReferencedMeasuredDoseReferenceNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedMeasuredDoseReferenceNumber() [2/2]

bool ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::getReferencedMeasuredDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedMeasuredDoseReferenceNumberTag()

std::string ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::getReferencedMeasuredDoseReferenceNumberTag ( ) const

inline

Definition at line 117 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

getSequence()

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

inline

Return the DRTReferencedMeasuredDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedMeasuredDoseReferenceSequence

Definition at line 129 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTReferencedMeasuredDoseReferenceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::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 167 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::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 179 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

setMeasuredDoseValue()

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

setReferencedDoseReferenceNumber()

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

setReferencedMeasuredDoseReferenceNumber()

bool ml::DcmDRTReferencedMeasuredDoseReferenceSequenceInterface::setReferencedMeasuredDoseReferenceNumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTReferencedMeasuredDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedMeasuredDoseReferenceSequence

Definition at line 123 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTReferencedMeasuredDoseReferenceSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTReferencedMeasuredDoseReferenceSequenceInterface(), DcmDRTReferencedMeasuredDoseReferenceSequenceInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

---

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

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