ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface Class Reference

Class to provide access to DRTBrachyReferencedDoseReferenceSequence. More...

#include <mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTBrachyReferencedDoseReferenceSequenceInterface ()
	DcmDRTBrachyReferencedDoseReferenceSequenceInterface (std::vector< DcmDRTBrachyReferencedDoseReferenceSequenceInterface::Item > dcmSequence)
	Default Constructor. More...
	DcmDRTBrachyReferencedDoseReferenceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTBrachyReferencedDoseReferenceSequenceInterface ()
	Default virtual Destructor. More...
bool	getCumulativeDoseReferenceCoefficient (unsigned long idx, std::string &parameter) const
bool	getCumulativeDoseReferenceCoefficient (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCumulativeDoseReferenceCoefficientTag () const
bool	setCumulativeDoseReferenceCoefficient (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< DcmDRTBrachyReferencedDoseReferenceSequenceInterface::Item > dcmSequence)
	Set the DRTBrachyReferencedDoseReferenceSequence this interface class provides access to. More...
std::vector< DcmDRTBrachyReferencedDoseReferenceSequenceInterface::Item >	getSequence () const
	Return the DRTBrachyReferencedDoseReferenceSequence this interface class provides access to. More...
bool	hasSequence () const
	Check if the DRTBrachyReferencedDoseReferenceSequence is set. More...
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of. More...
DcmDRTBrachyReferencedDoseReferenceSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position. More...
DcmDRTBrachyReferencedDoseReferenceSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence. More...
void	addItem (DcmDRTBrachyReferencedDoseReferenceSequenceInterface::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< DcmDRTBrachyReferencedDoseReferenceSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector. More...

Detailed Description

Class to provide access to DRTBrachyReferencedDoseReferenceSequence.

Definition at line 43 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTBrachyReferencedDoseReferenceSequenceInterface() [1/3]

ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::DcmDRTBrachyReferencedDoseReferenceSequenceInterface ( )

inline

Definition at line 83 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

DcmDRTBrachyReferencedDoseReferenceSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

DcmDRTBrachyReferencedDoseReferenceSequenceInterface() [3/3]

ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::DcmDRTBrachyReferencedDoseReferenceSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

~DcmDRTBrachyReferencedDoseReferenceSequenceInterface()

virtual ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::~DcmDRTBrachyReferencedDoseReferenceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTBrachyReferencedDoseReferenceSequenceInterface::Item& ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 145 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

getCumulativeDoseReferenceCoefficient() [1/2]

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::getCumulativeDoseReferenceCoefficient	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getCumulativeDoseReferenceCoefficient() [2/2]

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::getCumulativeDoseReferenceCoefficient	(	unsigned long	idx,
		std::string &	parameter
	)		const

getCumulativeDoseReferenceCoefficientTag()

std::string ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::getCumulativeDoseReferenceCoefficientTag ( ) const

inline

Definition at line 100 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

Referenced by DRTBrachyReferencedDoseReferenceSequenceWrapper::getCumulativeDoseReferenceCoefficientTag().

getItem()

DcmDRTBrachyReferencedDoseReferenceSequenceInterface::Item ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::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 136 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

getNumberOfItems()

MLint ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::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 130 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

getReferencedDoseReferenceNumber() [1/2]

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

getReferencedDoseReferenceNumber() [2/2]

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

getReferencedDoseReferenceNumberTag()

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

inline

Definition at line 106 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

Referenced by DRTBrachyReferencedDoseReferenceSequenceWrapper::getReferencedDoseReferenceNumberTag().

getSequence()

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

inline

Return the DRTBrachyReferencedDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTBrachyReferencedDoseReferenceSequence

Definition at line 118 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTBrachyReferencedDoseReferenceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

insertItem()

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::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 156 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

removeItem()

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::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 168 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

setCumulativeDoseReferenceCoefficient()

bool ml::DcmDRTBrachyReferencedDoseReferenceSequenceInterface::setCumulativeDoseReferenceCoefficient	(	unsigned long	idx,
		std::string	parameter
	)

setReferencedDoseReferenceNumber()

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

setSequence()

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

inline

Set the DRTBrachyReferencedDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTBrachyReferencedDoseReferenceSequence

Definition at line 112 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h.

---

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

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