ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface Class Reference

Class to provide access to DRTReferencedCalculatedDoseReferenceSequence. More...

#include <mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h>

Classes
class	Item

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

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

Detailed Description

Class to provide access to DRTReferencedCalculatedDoseReferenceSequence.

Definition at line 43 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedCalculatedDoseReferenceSequenceInterface() [1/3]

ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface ( )

inline

Definition at line 88 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

DcmDRTReferencedCalculatedDoseReferenceSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

DcmDRTReferencedCalculatedDoseReferenceSequenceInterface() [3/3]

ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

~DcmDRTReferencedCalculatedDoseReferenceSequenceInterface()

virtual ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::~DcmDRTReferencedCalculatedDoseReferenceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::Item & ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

getCalculatedDoseReferenceDoseValue() [1/2]

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

getCalculatedDoseReferenceDoseValue() [2/2]

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

getCalculatedDoseReferenceDoseValueTag()

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

inline

Definition at line 105 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

getItem()

DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::Item ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

getReferencedCalculatedDoseReferenceNumber() [1/2]

bool ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::getReferencedCalculatedDoseReferenceNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedCalculatedDoseReferenceNumber() [2/2]

bool ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::getReferencedCalculatedDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedCalculatedDoseReferenceNumberTag()

std::string ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::getReferencedCalculatedDoseReferenceNumberTag ( ) const

inline

Definition at line 111 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

getReferencedDoseReferenceNumber() [1/2]

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

getReferencedDoseReferenceNumber() [2/2]

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

getReferencedDoseReferenceNumberTag()

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

inline

Definition at line 117 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

getSequence()

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

inline

Return the DRTReferencedCalculatedDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedCalculatedDoseReferenceSequence

Definition at line 129 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTReferencedCalculatedDoseReferenceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::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 mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

setCalculatedDoseReferenceDoseValue()

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

setReferencedCalculatedDoseReferenceNumber()

bool ml::DcmDRTReferencedCalculatedDoseReferenceSequenceInterface::setReferencedCalculatedDoseReferenceNumber	(	unsigned long	idx,
		std::string	parameter )

setReferencedDoseReferenceNumber()

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

setSequence()

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

inline

Set the DRTReferencedCalculatedDoseReferenceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedCalculatedDoseReferenceSequence

Definition at line 123 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTReferencedCalculatedDoseReferenceSequenceInterface.h.

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