ml::DcmDRTCalculatedDoseReferenceSequenceInterface Class Reference

Class to provide access to DRTCalculatedDoseReferenceSequence. More...

#include <mlDcmDRTCalculatedDoseReferenceSequenceInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTCalculatedDoseReferenceSequence.

Definition at line 43 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTCalculatedDoseReferenceSequenceInterface() [1/3]

ml::DcmDRTCalculatedDoseReferenceSequenceInterface::DcmDRTCalculatedDoseReferenceSequenceInterface ( )

inline

Definition at line 93 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

DcmDRTCalculatedDoseReferenceSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

DcmDRTCalculatedDoseReferenceSequenceInterface() [3/3]

ml::DcmDRTCalculatedDoseReferenceSequenceInterface::DcmDRTCalculatedDoseReferenceSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

References mlrange_cast().

~DcmDRTCalculatedDoseReferenceSequenceInterface()

virtual ml::DcmDRTCalculatedDoseReferenceSequenceInterface::~DcmDRTCalculatedDoseReferenceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTCalculatedDoseReferenceSequenceInterface::Item & ml::DcmDRTCalculatedDoseReferenceSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 167 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

References mlrange_cast().

getCalculatedDoseReferenceDescription() [1/2]

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCalculatedDoseReferenceDescription() [2/2]

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDescription	(	unsigned long	idx,
		std::string &	parameter ) const

getCalculatedDoseReferenceDescriptionTag()

std::string ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDescriptionTag ( ) const

inline

Definition at line 110 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

Referenced by DRTCalculatedDoseReferenceSequenceWrapper::getCalculatedDoseReferenceDescriptionTag().

getCalculatedDoseReferenceDoseValue() [1/2]

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDoseValue	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCalculatedDoseReferenceDoseValue() [2/2]

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDoseValue	(	unsigned long	idx,
		std::string &	parameter ) const

getCalculatedDoseReferenceDoseValueTag()

std::string ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceDoseValueTag ( ) const

inline

Definition at line 116 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

Referenced by DRTCalculatedDoseReferenceSequenceWrapper::getCalculatedDoseReferenceDoseValueTag().

getCalculatedDoseReferenceNumber() [1/2]

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCalculatedDoseReferenceNumber() [2/2]

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getCalculatedDoseReferenceNumberTag()

std::string ml::DcmDRTCalculatedDoseReferenceSequenceInterface::getCalculatedDoseReferenceNumberTag ( ) const

inline

Definition at line 122 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

Referenced by DRTCalculatedDoseReferenceSequenceWrapper::getCalculatedDoseReferenceNumberTag().

getItem()

DcmDRTCalculatedDoseReferenceSequenceInterface::Item ml::DcmDRTCalculatedDoseReferenceSequenceInterface::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 158 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTCalculatedDoseReferenceSequenceInterface::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 152 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

getReferencedDoseReferenceNumber() [1/2]

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

getReferencedDoseReferenceNumber() [2/2]

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

getReferencedDoseReferenceNumberTag()

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

inline

Definition at line 128 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

Referenced by DRTCalculatedDoseReferenceSequenceWrapper::getReferencedDoseReferenceNumberTag().

getSequence()

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

inline

Return the DRTCalculatedDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTCalculatedDoseReferenceSequence

Definition at line 140 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTCalculatedDoseReferenceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

insertItem()

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::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 178 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::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 190 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

References mlrange_cast().

setCalculatedDoseReferenceDescription()

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::setCalculatedDoseReferenceDescription	(	unsigned long	idx,
		std::string	parameter )

setCalculatedDoseReferenceDoseValue()

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::setCalculatedDoseReferenceDoseValue	(	unsigned long	idx,
		std::string	parameter )

setCalculatedDoseReferenceNumber()

bool ml::DcmDRTCalculatedDoseReferenceSequenceInterface::setCalculatedDoseReferenceNumber	(	unsigned long	idx,
		std::string	parameter )

setReferencedDoseReferenceNumber()

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

setSequence()

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

inline

Set the DRTCalculatedDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTCalculatedDoseReferenceSequence

Definition at line 134 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTCalculatedDoseReferenceSequenceInterface.h.

---

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

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