ml::DcmDRTDVHSequenceInterface Class Reference

Class to provide access to DRTDVHSequence. More...

#include <mlDcmDRTDVHSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTDVHSequenceInterface ()
	DcmDRTDVHSequenceInterface (std::vector< DcmDRTDVHSequenceInterface::Item > dcmSequence)
	Default Constructor. More...
	DcmDRTDVHSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTDVHSequenceInterface ()
	Default virtual Destructor. More...
bool	getDVHData (unsigned long idx, std::string &parameter) const
bool	getDVHData (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDVHDataTag () const
bool	setDVHData (unsigned long idx, std::string parameter)
bool	getDVHDoseScaling (unsigned long idx, std::string &parameter) const
bool	getDVHDoseScaling (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDVHDoseScalingTag () const
bool	setDVHDoseScaling (unsigned long idx, std::string parameter)
bool	getDVHMaximumDose (unsigned long idx, std::string &parameter) const
bool	getDVHMaximumDose (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDVHMaximumDoseTag () const
bool	setDVHMaximumDose (unsigned long idx, std::string parameter)
bool	getDVHMeanDose (unsigned long idx, std::string &parameter) const
bool	getDVHMeanDose (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDVHMeanDoseTag () const
bool	setDVHMeanDose (unsigned long idx, std::string parameter)
bool	getDVHMinimumDose (unsigned long idx, std::string &parameter) const
bool	getDVHMinimumDose (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDVHMinimumDoseTag () const
bool	setDVHMinimumDose (unsigned long idx, std::string parameter)
bool	getDVHNumberOfBins (unsigned long idx, std::string &parameter) const
bool	getDVHNumberOfBins (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDVHNumberOfBinsTag () const
bool	setDVHNumberOfBins (unsigned long idx, std::string parameter)
bool	getDVHType (unsigned long idx, std::string &parameter) const
bool	getDVHType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDVHTypeTag () const
bool	setDVHType (unsigned long idx, std::string parameter)
bool	getDVHVolumeUnits (unsigned long idx, std::string &parameter) const
bool	getDVHVolumeUnits (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDVHVolumeUnitsTag () const
bool	setDVHVolumeUnits (unsigned long idx, std::string parameter)
bool	getDoseType (unsigned long idx, std::string &parameter) const
bool	getDoseType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDoseTypeTag () const
bool	setDoseType (unsigned long idx, std::string parameter)
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)
DcmDRTDVHReferencedROISequenceInterface	getDVHReferencedROISequence (unsigned long idx) const
std::string	getDVHReferencedROISequenceTag () const
void	setDVHReferencedROISequence (DcmDRTDVHReferencedROISequenceInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTDVHSequenceInterface::Item > dcmSequence)
	Set the DRTDVHSequence this interface class provides access to. More...
std::vector< DcmDRTDVHSequenceInterface::Item >	getSequence () const
	Return the DRTDVHSequence this interface class provides access to. More...
bool	hasSequence () const
	Check if the DRTDVHSequence is set. More...
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of. More...
DcmDRTDVHSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position. More...
DcmDRTDVHSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence. More...
void	addItem (DcmDRTDVHSequenceInterface::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< DcmDRTDVHSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector. More...

Detailed Description

Class to provide access to DRTDVHSequence.

Definition at line 44 of file mlDcmDRTDVHSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTDVHSequenceInterface() [1/3]

ml::DcmDRTDVHSequenceInterface::DcmDRTDVHSequenceInterface ( )

inline

Definition at line 129 of file mlDcmDRTDVHSequenceInterface.h.

DcmDRTDVHSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 132 of file mlDcmDRTDVHSequenceInterface.h.

DcmDRTDVHSequenceInterface() [3/3]

ml::DcmDRTDVHSequenceInterface::DcmDRTDVHSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 134 of file mlDcmDRTDVHSequenceInterface.h.

~DcmDRTDVHSequenceInterface()

virtual ml::DcmDRTDVHSequenceInterface::~DcmDRTDVHSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 142 of file mlDcmDRTDVHSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTDVHSequenceInterface::Item& ml::DcmDRTDVHSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 244 of file mlDcmDRTDVHSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 249 of file mlDcmDRTDVHSequenceInterface.h.

getDoseType() [1/2]

bool ml::DcmDRTDVHSequenceInterface::getDoseType	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getDoseType() [2/2]

bool ml::DcmDRTDVHSequenceInterface::getDoseType	(	unsigned long	idx,
		std::string &	parameter
	)		const

getDoseTypeTag()

std::string ml::DcmDRTDVHSequenceInterface::getDoseTypeTag ( ) const

inline

Definition at line 194 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDoseTypeTag().

getDoseUnits() [1/2]

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

getDoseUnits() [2/2]

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

getDoseUnitsTag()

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

inline

Definition at line 200 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDoseUnitsTag().

getDVHData() [1/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHData	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getDVHData() [2/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHData	(	unsigned long	idx,
		std::string &	parameter
	)		const

getDVHDataTag()

std::string ml::DcmDRTDVHSequenceInterface::getDVHDataTag ( ) const

inline

Definition at line 146 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDVHDataTag().

getDVHDoseScaling() [1/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHDoseScaling	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getDVHDoseScaling() [2/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHDoseScaling	(	unsigned long	idx,
		std::string &	parameter
	)		const

getDVHDoseScalingTag()

std::string ml::DcmDRTDVHSequenceInterface::getDVHDoseScalingTag ( ) const

inline

Definition at line 152 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDVHDoseScalingTag().

getDVHMaximumDose() [1/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHMaximumDose	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getDVHMaximumDose() [2/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHMaximumDose	(	unsigned long	idx,
		std::string &	parameter
	)		const

getDVHMaximumDoseTag()

std::string ml::DcmDRTDVHSequenceInterface::getDVHMaximumDoseTag ( ) const

inline

Definition at line 158 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDVHMaximumDoseTag().

getDVHMeanDose() [1/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHMeanDose	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getDVHMeanDose() [2/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHMeanDose	(	unsigned long	idx,
		std::string &	parameter
	)		const

getDVHMeanDoseTag()

std::string ml::DcmDRTDVHSequenceInterface::getDVHMeanDoseTag ( ) const

inline

Definition at line 164 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDVHMeanDoseTag().

getDVHMinimumDose() [1/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHMinimumDose	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getDVHMinimumDose() [2/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHMinimumDose	(	unsigned long	idx,
		std::string &	parameter
	)		const

getDVHMinimumDoseTag()

std::string ml::DcmDRTDVHSequenceInterface::getDVHMinimumDoseTag ( ) const

inline

Definition at line 170 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDVHMinimumDoseTag().

getDVHNumberOfBins() [1/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHNumberOfBins	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getDVHNumberOfBins() [2/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHNumberOfBins	(	unsigned long	idx,
		std::string &	parameter
	)		const

getDVHNumberOfBinsTag()

std::string ml::DcmDRTDVHSequenceInterface::getDVHNumberOfBinsTag ( ) const

inline

Definition at line 176 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDVHNumberOfBinsTag().

getDVHReferencedROISequence()

DcmDRTDVHReferencedROISequenceInterface ml::DcmDRTDVHSequenceInterface::getDVHReferencedROISequence

(

unsigned long

idx

)

const

getDVHReferencedROISequenceTag()

std::string ml::DcmDRTDVHSequenceInterface::getDVHReferencedROISequenceTag ( ) const

inline

Definition at line 205 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDVHReferencedROISequenceTag().

getDVHType() [1/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHType	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getDVHType() [2/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHType	(	unsigned long	idx,
		std::string &	parameter
	)		const

getDVHTypeTag()

std::string ml::DcmDRTDVHSequenceInterface::getDVHTypeTag ( ) const

inline

Definition at line 182 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDVHTypeTag().

getDVHVolumeUnits() [1/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHVolumeUnits	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getDVHVolumeUnits() [2/2]

bool ml::DcmDRTDVHSequenceInterface::getDVHVolumeUnits	(	unsigned long	idx,
		std::string &	parameter
	)		const

getDVHVolumeUnitsTag()

std::string ml::DcmDRTDVHSequenceInterface::getDVHVolumeUnitsTag ( ) const

inline

Definition at line 188 of file mlDcmDRTDVHSequenceInterface.h.

Referenced by DRTDVHSequenceWrapper::getDVHVolumeUnitsTag().

getItem()

DcmDRTDVHSequenceInterface::Item ml::DcmDRTDVHSequenceInterface::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 235 of file mlDcmDRTDVHSequenceInterface.h.

getNumberOfItems()

MLint ml::DcmDRTDVHSequenceInterface::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 229 of file mlDcmDRTDVHSequenceInterface.h.

getSequence()

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

inline

Return the DRTDVHSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTDVHSequence

Definition at line 217 of file mlDcmDRTDVHSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTDVHSequenceInterface::hasSequence ( ) const

inline

Check if the DRTDVHSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 223 of file mlDcmDRTDVHSequenceInterface.h.

insertItem()

bool ml::DcmDRTDVHSequenceInterface::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 255 of file mlDcmDRTDVHSequenceInterface.h.

removeItem()

bool ml::DcmDRTDVHSequenceInterface::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 267 of file mlDcmDRTDVHSequenceInterface.h.

setDoseType()

bool ml::DcmDRTDVHSequenceInterface::setDoseType	(	unsigned long	idx,
		std::string	parameter
	)

setDoseUnits()

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

setDVHData()

bool ml::DcmDRTDVHSequenceInterface::setDVHData	(	unsigned long	idx,
		std::string	parameter
	)

setDVHDoseScaling()

bool ml::DcmDRTDVHSequenceInterface::setDVHDoseScaling	(	unsigned long	idx,
		std::string	parameter
	)

setDVHMaximumDose()

bool ml::DcmDRTDVHSequenceInterface::setDVHMaximumDose	(	unsigned long	idx,
		std::string	parameter
	)

setDVHMeanDose()

bool ml::DcmDRTDVHSequenceInterface::setDVHMeanDose	(	unsigned long	idx,
		std::string	parameter
	)

setDVHMinimumDose()

bool ml::DcmDRTDVHSequenceInterface::setDVHMinimumDose	(	unsigned long	idx,
		std::string	parameter
	)

setDVHNumberOfBins()

bool ml::DcmDRTDVHSequenceInterface::setDVHNumberOfBins	(	unsigned long	idx,
		std::string	parameter
	)

setDVHReferencedROISequence()

void ml::DcmDRTDVHSequenceInterface::setDVHReferencedROISequence	(	DcmDRTDVHReferencedROISequenceInterface	seq,
		unsigned long	idx
	)

setDVHType()

bool ml::DcmDRTDVHSequenceInterface::setDVHType	(	unsigned long	idx,
		std::string	parameter
	)

setDVHVolumeUnits()

bool ml::DcmDRTDVHSequenceInterface::setDVHVolumeUnits	(	unsigned long	idx,
		std::string	parameter
	)

setSequence()

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

inline

Set the DRTDVHSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTDVHSequence

Definition at line 211 of file mlDcmDRTDVHSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 279 of file mlDcmDRTDVHSequenceInterface.h.

---

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

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