ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface Class Reference

Class to provide access to DRTTreatmentSummaryCalculatedDoseReferenceSequence. More...

#include <mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h>

Classes
class	Item

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

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

Detailed Description

Class to provide access to DRTTreatmentSummaryCalculatedDoseReferenceSequence.

Definition at line 43 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface() [1/3]

ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface ( )

inline

Definition at line 88 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface() [3/3]

ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

~DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface()

virtual ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::~DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::Item & ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

getCumulativeDoseToDoseReference() [1/2]

bool ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::getCumulativeDoseToDoseReference	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCumulativeDoseToDoseReference() [2/2]

bool ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::getCumulativeDoseToDoseReference	(	unsigned long	idx,
		std::string &	parameter ) const

getCumulativeDoseToDoseReferenceTag()

std::string ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::getCumulativeDoseToDoseReferenceTag ( ) const

inline

Definition at line 105 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

getDoseReferenceDescription() [1/2]

bool ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::getDoseReferenceDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getDoseReferenceDescription() [2/2]

bool ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::getDoseReferenceDescription	(	unsigned long	idx,
		std::string &	parameter ) const

getDoseReferenceDescriptionTag()

std::string ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::getDoseReferenceDescriptionTag ( ) const

inline

Definition at line 111 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

getItem()

DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::Item ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

getReferencedDoseReferenceNumber() [1/2]

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

getReferencedDoseReferenceNumber() [2/2]

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

getReferencedDoseReferenceNumberTag()

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

inline

Definition at line 117 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

getSequence()

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

inline

Return the DRTTreatmentSummaryCalculatedDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTTreatmentSummaryCalculatedDoseReferenceSequence

Definition at line 129 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTTreatmentSummaryCalculatedDoseReferenceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

setCumulativeDoseToDoseReference()

bool ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::setCumulativeDoseToDoseReference	(	unsigned long	idx,
		std::string	parameter )

setDoseReferenceDescription()

bool ml::DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface::setDoseReferenceDescription	(	unsigned long	idx,
		std::string	parameter )

setReferencedDoseReferenceNumber()

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

setSequence()

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

inline

Set the DRTTreatmentSummaryCalculatedDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTTreatmentSummaryCalculatedDoseReferenceSequence

Definition at line 123 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface(), DcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface(), 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/mlDcmDRTTreatmentSummaryCalculatedDoseReferenceSequenceInterface.h