ml::DcmDRTRTDoseROISequenceInterface Class Reference

Class to provide access to DRTRTDoseROISequence. More...

#include <mlDcmDRTRTDoseROISequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTRTDoseROISequenceInterface ()
	DcmDRTRTDoseROISequenceInterface (std::vector< DcmDRTRTDoseROISequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTRTDoseROISequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTRTDoseROISequenceInterface ()
	Default virtual Destructor.
bool	getDoseUnits (unsigned long idx, std::string &parameter) const
bool	getDoseUnits (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDoseUnitsTag () const
bool	setDoseUnits (unsigned long idx, std::string parameter)
bool	getDoseValue (unsigned long idx, std::string &parameter) const
bool	getDoseValue (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDoseValueTag () const
bool	setDoseValue (unsigned long idx, std::string parameter)
bool	getReferencedROINumber (unsigned long idx, std::string &parameter) const
bool	getReferencedROINumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedROINumberTag () const
bool	setReferencedROINumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTRTDoseROISequenceInterface::Item > dcmSequence)
std::vector< DcmDRTRTDoseROISequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTRTDoseROISequenceInterface::Item	getItem (const size_t idx) const
DcmDRTRTDoseROISequenceInterface::Item &	addItem ()
void	addItem (DcmDRTRTDoseROISequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTRTDoseROISequence.

Definition at line 43 of file mlDcmDRTRTDoseROISequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTRTDoseROISequenceInterface() [1/3]

ml::DcmDRTRTDoseROISequenceInterface::DcmDRTRTDoseROISequenceInterface ( )

inline

Definition at line 88 of file mlDcmDRTRTDoseROISequenceInterface.h.

DcmDRTRTDoseROISequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

DcmDRTRTDoseROISequenceInterface() [3/3]

ml::DcmDRTRTDoseROISequenceInterface::DcmDRTRTDoseROISequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

~DcmDRTRTDoseROISequenceInterface()

virtual ml::DcmDRTRTDoseROISequenceInterface::~DcmDRTRTDoseROISequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTRTDoseROISequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTRTDoseROISequenceInterface::Item & ml::DcmDRTRTDoseROISequenceInterface::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 mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

getDoseUnits() [1/2]

bool ml::DcmDRTRTDoseROISequenceInterface::getDoseUnits	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getDoseUnits() [2/2]

bool ml::DcmDRTRTDoseROISequenceInterface::getDoseUnits	(	unsigned long	idx,
		std::string &	parameter ) const

getDoseUnitsTag()

std::string ml::DcmDRTRTDoseROISequenceInterface::getDoseUnitsTag ( ) const

inline

Definition at line 105 of file mlDcmDRTRTDoseROISequenceInterface.h.

getDoseValue() [1/2]

bool ml::DcmDRTRTDoseROISequenceInterface::getDoseValue	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getDoseValue() [2/2]

bool ml::DcmDRTRTDoseROISequenceInterface::getDoseValue	(	unsigned long	idx,
		std::string &	parameter ) const

getDoseValueTag()

std::string ml::DcmDRTRTDoseROISequenceInterface::getDoseValueTag ( ) const

inline

Definition at line 111 of file mlDcmDRTRTDoseROISequenceInterface.h.

getItem()

DcmDRTRTDoseROISequenceInterface::Item ml::DcmDRTRTDoseROISequenceInterface::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 mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTRTDoseROISequenceInterface::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 mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

getReferencedROINumber() [1/2]

bool ml::DcmDRTRTDoseROISequenceInterface::getReferencedROINumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedROINumber() [2/2]

bool ml::DcmDRTRTDoseROISequenceInterface::getReferencedROINumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedROINumberTag()

std::string ml::DcmDRTRTDoseROISequenceInterface::getReferencedROINumberTag ( ) const

inline

Definition at line 117 of file mlDcmDRTRTDoseROISequenceInterface.h.

getSequence()

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

inline

Return the DRTRTDoseROISequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRTDoseROISequence

Definition at line 129 of file mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTRTDoseROISequenceInterface::hasSequence ( ) const

inline

Check if the DRTRTDoseROISequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTRTDoseROISequenceInterface::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 mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTRTDoseROISequenceInterface::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 mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

setDoseUnits()

bool ml::DcmDRTRTDoseROISequenceInterface::setDoseUnits	(	unsigned long	idx,
		std::string	parameter )

setDoseValue()

bool ml::DcmDRTRTDoseROISequenceInterface::setDoseValue	(	unsigned long	idx,
		std::string	parameter )

setReferencedROINumber()

bool ml::DcmDRTRTDoseROISequenceInterface::setReferencedROINumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTRTDoseROISequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRTDoseROISequence

Definition at line 123 of file mlDcmDRTRTDoseROISequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTRTDoseROISequenceInterface.h.

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