ml::DcmDRTSourceSequenceInterface Class Reference

Class to provide access to DRTSourceSequence. More...

#include <mlDcmDRTSourceSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTSourceSequenceInterface ()
	DcmDRTSourceSequenceInterface (std::vector< DcmDRTSourceSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTSourceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTSourceSequenceInterface ()
	Default virtual Destructor.
bool	getActiveSourceDiameter (unsigned long idx, std::string &parameter) const
bool	getActiveSourceDiameter (DCMTree::TreePtr item, std::string &parameter) const
std::string	getActiveSourceDiameterTag () const
bool	setActiveSourceDiameter (unsigned long idx, std::string parameter)
bool	getActiveSourceLength (unsigned long idx, std::string &parameter) const
bool	getActiveSourceLength (DCMTree::TreePtr item, std::string &parameter) const
std::string	getActiveSourceLengthTag () const
bool	setActiveSourceLength (unsigned long idx, std::string parameter)
bool	getMaterialID (unsigned long idx, std::string &parameter) const
bool	getMaterialID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getMaterialIDTag () const
bool	setMaterialID (unsigned long idx, std::string parameter)
bool	getReferenceAirKermaRate (unsigned long idx, std::string &parameter) const
bool	getReferenceAirKermaRate (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferenceAirKermaRateTag () const
bool	setReferenceAirKermaRate (unsigned long idx, std::string parameter)
bool	getSourceEncapsulationNominalThickness (unsigned long idx, std::string &parameter) const
bool	getSourceEncapsulationNominalThickness (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceEncapsulationNominalThicknessTag () const
bool	setSourceEncapsulationNominalThickness (unsigned long idx, std::string parameter)
bool	getSourceEncapsulationNominalTransmission (unsigned long idx, std::string &parameter) const
bool	getSourceEncapsulationNominalTransmission (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceEncapsulationNominalTransmissionTag () const
bool	setSourceEncapsulationNominalTransmission (unsigned long idx, std::string parameter)
bool	getSourceIsotopeHalfLife (unsigned long idx, std::string &parameter) const
bool	getSourceIsotopeHalfLife (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceIsotopeHalfLifeTag () const
bool	setSourceIsotopeHalfLife (unsigned long idx, std::string parameter)
bool	getSourceIsotopeName (unsigned long idx, std::string &parameter) const
bool	getSourceIsotopeName (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceIsotopeNameTag () const
bool	setSourceIsotopeName (unsigned long idx, std::string parameter)
bool	getSourceManufacturer (unsigned long idx, std::string &parameter) const
bool	getSourceManufacturer (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceManufacturerTag () const
bool	setSourceManufacturer (unsigned long idx, std::string parameter)
bool	getSourceNumber (unsigned long idx, std::string &parameter) const
bool	getSourceNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceNumberTag () const
bool	setSourceNumber (unsigned long idx, std::string parameter)
bool	getSourceStrength (unsigned long idx, std::string &parameter) const
bool	getSourceStrength (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceStrengthTag () const
bool	setSourceStrength (unsigned long idx, std::string parameter)
bool	getSourceStrengthReferenceDate (unsigned long idx, std::string &parameter) const
bool	getSourceStrengthReferenceDate (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceStrengthReferenceDateTag () const
bool	setSourceStrengthReferenceDate (unsigned long idx, std::string parameter)
bool	getSourceStrengthReferenceTime (unsigned long idx, std::string &parameter) const
bool	getSourceStrengthReferenceTime (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceStrengthReferenceTimeTag () const
bool	setSourceStrengthReferenceTime (unsigned long idx, std::string parameter)
bool	getSourceStrengthUnits (unsigned long idx, std::string &parameter) const
bool	getSourceStrengthUnits (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceStrengthUnitsTag () const
bool	setSourceStrengthUnits (unsigned long idx, std::string parameter)
bool	getSourceType (unsigned long idx, std::string &parameter) const
bool	getSourceType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceTypeTag () const
bool	setSourceType (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTSourceSequenceInterface::Item > dcmSequence)
	Set the DRTSourceSequence this interface class provides access to.
std::vector< DcmDRTSourceSequenceInterface::Item >	getSequence () const
	Return the DRTSourceSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTSourceSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTSourceSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTSourceSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTSourceSequenceInterface::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< DcmDRTSourceSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTSourceSequence.

Definition at line 43 of file mlDcmDRTSourceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTSourceSequenceInterface() [1/3]

ml::DcmDRTSourceSequenceInterface::DcmDRTSourceSequenceInterface ( )

inline

Definition at line 148 of file mlDcmDRTSourceSequenceInterface.h.

DcmDRTSourceSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 151 of file mlDcmDRTSourceSequenceInterface.h.

DcmDRTSourceSequenceInterface() [3/3]

ml::DcmDRTSourceSequenceInterface::DcmDRTSourceSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 153 of file mlDcmDRTSourceSequenceInterface.h.

References mlrange_cast().

~DcmDRTSourceSequenceInterface()

virtual ml::DcmDRTSourceSequenceInterface::~DcmDRTSourceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 161 of file mlDcmDRTSourceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTSourceSequenceInterface::Item & ml::DcmDRTSourceSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 288 of file mlDcmDRTSourceSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 293 of file mlDcmDRTSourceSequenceInterface.h.

References mlrange_cast().

getActiveSourceDiameter() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getActiveSourceDiameter	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getActiveSourceDiameter() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getActiveSourceDiameter	(	unsigned long	idx,
		std::string &	parameter ) const

getActiveSourceDiameterTag()

std::string ml::DcmDRTSourceSequenceInterface::getActiveSourceDiameterTag ( ) const

inline

Definition at line 165 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getActiveSourceDiameterTag().

getActiveSourceLength() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getActiveSourceLength	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getActiveSourceLength() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getActiveSourceLength	(	unsigned long	idx,
		std::string &	parameter ) const

getActiveSourceLengthTag()

std::string ml::DcmDRTSourceSequenceInterface::getActiveSourceLengthTag ( ) const

inline

Definition at line 171 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getActiveSourceLengthTag().

getItem()

DcmDRTSourceSequenceInterface::Item ml::DcmDRTSourceSequenceInterface::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 279 of file mlDcmDRTSourceSequenceInterface.h.

References mlrange_cast().

getMaterialID() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getMaterialID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getMaterialID() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getMaterialID	(	unsigned long	idx,
		std::string &	parameter ) const

getMaterialIDTag()

std::string ml::DcmDRTSourceSequenceInterface::getMaterialIDTag ( ) const

inline

Definition at line 177 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getMaterialIDTag().

getNumberOfItems()

MLint ml::DcmDRTSourceSequenceInterface::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 273 of file mlDcmDRTSourceSequenceInterface.h.

getReferenceAirKermaRate() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getReferenceAirKermaRate	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferenceAirKermaRate() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getReferenceAirKermaRate	(	unsigned long	idx,
		std::string &	parameter ) const

getReferenceAirKermaRateTag()

std::string ml::DcmDRTSourceSequenceInterface::getReferenceAirKermaRateTag ( ) const

inline

Definition at line 183 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getReferenceAirKermaRateTag().

getSequence()

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

inline

Return the DRTSourceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTSourceSequence

Definition at line 261 of file mlDcmDRTSourceSequenceInterface.h.

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

getSourceEncapsulationNominalThickness() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalThickness	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceEncapsulationNominalThickness() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalThickness	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceEncapsulationNominalThicknessTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalThicknessTag ( ) const

inline

Definition at line 189 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceEncapsulationNominalThicknessTag().

getSourceEncapsulationNominalTransmission() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalTransmission	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceEncapsulationNominalTransmission() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalTransmission	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceEncapsulationNominalTransmissionTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalTransmissionTag ( ) const

inline

Definition at line 195 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceEncapsulationNominalTransmissionTag().

getSourceIsotopeHalfLife() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceIsotopeHalfLife	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceIsotopeHalfLife() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceIsotopeHalfLife	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceIsotopeHalfLifeTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceIsotopeHalfLifeTag ( ) const

inline

Definition at line 201 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceIsotopeHalfLifeTag().

getSourceIsotopeName() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceIsotopeName	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceIsotopeName() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceIsotopeName	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceIsotopeNameTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceIsotopeNameTag ( ) const

inline

Definition at line 207 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceIsotopeNameTag().

getSourceManufacturer() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceManufacturer	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceManufacturer() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceManufacturer	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceManufacturerTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceManufacturerTag ( ) const

inline

Definition at line 213 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceManufacturerTag().

getSourceNumber() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceNumber() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceNumberTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceNumberTag ( ) const

inline

Definition at line 219 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceNumberTag().

getSourceStrength() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceStrength	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceStrength() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceStrength	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceStrengthReferenceDate() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceDate	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceStrengthReferenceDate() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceDate	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceStrengthReferenceDateTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceDateTag ( ) const

inline

Definition at line 231 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceStrengthReferenceDateTag().

getSourceStrengthReferenceTime() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceTime	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceStrengthReferenceTime() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceTime	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceStrengthReferenceTimeTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceTimeTag ( ) const

inline

Definition at line 237 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceStrengthReferenceTimeTag().

getSourceStrengthTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceStrengthTag ( ) const

inline

Definition at line 225 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceStrengthTag().

getSourceStrengthUnits() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthUnits	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceStrengthUnits() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthUnits	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceStrengthUnitsTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceStrengthUnitsTag ( ) const

inline

Definition at line 243 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceStrengthUnitsTag().

getSourceType() [1/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceType() [2/2]

bool ml::DcmDRTSourceSequenceInterface::getSourceType	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceTypeTag()

std::string ml::DcmDRTSourceSequenceInterface::getSourceTypeTag ( ) const

inline

Definition at line 249 of file mlDcmDRTSourceSequenceInterface.h.

Referenced by DRTSourceSequenceWrapper::getSourceTypeTag().

hasSequence()

bool ml::DcmDRTSourceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTSourceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 267 of file mlDcmDRTSourceSequenceInterface.h.

insertItem()

bool ml::DcmDRTSourceSequenceInterface::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 299 of file mlDcmDRTSourceSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTSourceSequenceInterface::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 311 of file mlDcmDRTSourceSequenceInterface.h.

References mlrange_cast().

setActiveSourceDiameter()

bool ml::DcmDRTSourceSequenceInterface::setActiveSourceDiameter	(	unsigned long	idx,
		std::string	parameter )

setActiveSourceLength()

bool ml::DcmDRTSourceSequenceInterface::setActiveSourceLength	(	unsigned long	idx,
		std::string	parameter )

setMaterialID()

bool ml::DcmDRTSourceSequenceInterface::setMaterialID	(	unsigned long	idx,
		std::string	parameter )

setReferenceAirKermaRate()

bool ml::DcmDRTSourceSequenceInterface::setReferenceAirKermaRate	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTSourceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTSourceSequence

Definition at line 255 of file mlDcmDRTSourceSequenceInterface.h.

References mlrange_cast().

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

setSourceEncapsulationNominalThickness()

bool ml::DcmDRTSourceSequenceInterface::setSourceEncapsulationNominalThickness	(	unsigned long	idx,
		std::string	parameter )

setSourceEncapsulationNominalTransmission()

bool ml::DcmDRTSourceSequenceInterface::setSourceEncapsulationNominalTransmission	(	unsigned long	idx,
		std::string	parameter )

setSourceIsotopeHalfLife()

bool ml::DcmDRTSourceSequenceInterface::setSourceIsotopeHalfLife	(	unsigned long	idx,
		std::string	parameter )

setSourceIsotopeName()

bool ml::DcmDRTSourceSequenceInterface::setSourceIsotopeName	(	unsigned long	idx,
		std::string	parameter )

setSourceManufacturer()

bool ml::DcmDRTSourceSequenceInterface::setSourceManufacturer	(	unsigned long	idx,
		std::string	parameter )

setSourceNumber()

bool ml::DcmDRTSourceSequenceInterface::setSourceNumber	(	unsigned long	idx,
		std::string	parameter )

setSourceStrength()

bool ml::DcmDRTSourceSequenceInterface::setSourceStrength	(	unsigned long	idx,
		std::string	parameter )

setSourceStrengthReferenceDate()

bool ml::DcmDRTSourceSequenceInterface::setSourceStrengthReferenceDate	(	unsigned long	idx,
		std::string	parameter )

setSourceStrengthReferenceTime()

bool ml::DcmDRTSourceSequenceInterface::setSourceStrengthReferenceTime	(	unsigned long	idx,
		std::string	parameter )

setSourceStrengthUnits()

bool ml::DcmDRTSourceSequenceInterface::setSourceStrengthUnits	(	unsigned long	idx,
		std::string	parameter )

setSourceType()

bool ml::DcmDRTSourceSequenceInterface::setSourceType	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 323 of file mlDcmDRTSourceSequenceInterface.h.

---

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

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