ml::DcmDRTExposureSequenceInterface Class Reference

Class to provide access to DRTExposureSequence. More...

#include <mlDcmDRTExposureSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTExposureSequenceInterface ()
	DcmDRTExposureSequenceInterface (std::vector< DcmDRTExposureSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTExposureSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTExposureSequenceInterface ()
	Default virtual Destructor.
bool	getDiaphragmPosition (unsigned long idx, std::string &parameter) const
bool	getDiaphragmPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string	getDiaphragmPositionTag () const
bool	setDiaphragmPosition (unsigned long idx, std::string parameter)
bool	getExposureTime (unsigned long idx, std::string &parameter) const
bool	getExposureTime (DCMTree::TreePtr item, std::string &parameter) const
std::string	getExposureTimeTag () const
bool	setExposureTime (unsigned long idx, std::string parameter)
bool	getFluenceDataScale (unsigned long idx, std::string &parameter) const
bool	getFluenceDataScale (DCMTree::TreePtr item, std::string &parameter) const
std::string	getFluenceDataScaleTag () const
bool	setFluenceDataScale (unsigned long idx, std::string parameter)
bool	getFluenceDataSource (unsigned long idx, std::string &parameter) const
bool	getFluenceDataSource (DCMTree::TreePtr item, std::string &parameter) const
std::string	getFluenceDataSourceTag () const
bool	setFluenceDataSource (unsigned long idx, std::string parameter)
bool	getKVP (unsigned long idx, std::string &parameter) const
bool	getKVP (DCMTree::TreePtr item, std::string &parameter) const
std::string	getKVPTag () const
bool	setKVP (unsigned long idx, std::string parameter)
bool	getMetersetExposure (unsigned long idx, std::string &parameter) const
bool	getMetersetExposure (DCMTree::TreePtr item, std::string &parameter) const
std::string	getMetersetExposureTag () const
bool	setMetersetExposure (unsigned long idx, std::string parameter)
bool	getNumberOfBlocks (unsigned long idx, std::string &parameter) const
bool	getNumberOfBlocks (DCMTree::TreePtr item, std::string &parameter) const
std::string	getNumberOfBlocksTag () const
bool	setNumberOfBlocks (unsigned long idx, std::string parameter)
bool	getReferencedFrameNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedFrameNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedFrameNumberTag () const
bool	setReferencedFrameNumber (unsigned long idx, std::string parameter)
bool	getXRayTubeCurrent (unsigned long idx, std::string &parameter) const
bool	getXRayTubeCurrent (DCMTree::TreePtr item, std::string &parameter) const
std::string	getXRayTubeCurrentTag () const
bool	setXRayTubeCurrent (unsigned long idx, std::string parameter)
DcmDRTApplicatorSequenceInRTImageModuleInterface	getApplicatorSequence (unsigned long idx) const
std::string	getApplicatorSequenceTag () const
void	setApplicatorSequence (DcmDRTApplicatorSequenceInRTImageModuleInterface seq, unsigned long idx)
DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface	getBeamLimitingDeviceSequence (unsigned long idx) const
std::string	getBeamLimitingDeviceSequenceTag () const
void	setBeamLimitingDeviceSequence (DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface seq, unsigned long idx)
DcmDRTBlockSequenceInRTImageModuleInterface	getBlockSequence (unsigned long idx) const
std::string	getBlockSequenceTag () const
void	setBlockSequence (DcmDRTBlockSequenceInRTImageModuleInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTExposureSequenceInterface::Item > dcmSequence)
	Set the DRTExposureSequence this interface class provides access to.
std::vector< DcmDRTExposureSequenceInterface::Item >	getSequence () const
	Return the DRTExposureSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTExposureSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTExposureSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTExposureSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTExposureSequenceInterface::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< DcmDRTExposureSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTExposureSequence.

Definition at line 46 of file mlDcmDRTExposureSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTExposureSequenceInterface() [1/3]

ml::DcmDRTExposureSequenceInterface::DcmDRTExposureSequenceInterface ( )

inline

Definition at line 136 of file mlDcmDRTExposureSequenceInterface.h.

DcmDRTExposureSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 139 of file mlDcmDRTExposureSequenceInterface.h.

DcmDRTExposureSequenceInterface() [3/3]

ml::DcmDRTExposureSequenceInterface::DcmDRTExposureSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 141 of file mlDcmDRTExposureSequenceInterface.h.

References mlrange_cast().

~DcmDRTExposureSequenceInterface()

virtual ml::DcmDRTExposureSequenceInterface::~DcmDRTExposureSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 149 of file mlDcmDRTExposureSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTExposureSequenceInterface::Item & ml::DcmDRTExposureSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 255 of file mlDcmDRTExposureSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 260 of file mlDcmDRTExposureSequenceInterface.h.

References mlrange_cast().

getApplicatorSequence()

DcmDRTApplicatorSequenceInRTImageModuleInterface ml::DcmDRTExposureSequenceInterface::getApplicatorSequence

(

unsigned long

idx

)

const

getApplicatorSequenceTag()

std::string ml::DcmDRTExposureSequenceInterface::getApplicatorSequenceTag ( ) const

inline

Definition at line 206 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getApplicatorSequenceTag().

getBeamLimitingDeviceSequence()

DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface ml::DcmDRTExposureSequenceInterface::getBeamLimitingDeviceSequence

(

unsigned long

idx

)

const

getBeamLimitingDeviceSequenceTag()

std::string ml::DcmDRTExposureSequenceInterface::getBeamLimitingDeviceSequenceTag ( ) const

inline

Definition at line 211 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getBeamLimitingDeviceSequenceTag().

getBlockSequence()

DcmDRTBlockSequenceInRTImageModuleInterface ml::DcmDRTExposureSequenceInterface::getBlockSequence

(

unsigned long

idx

)

const

getBlockSequenceTag()

std::string ml::DcmDRTExposureSequenceInterface::getBlockSequenceTag ( ) const

inline

Definition at line 216 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getBlockSequenceTag().

getDiaphragmPosition() [1/2]

bool ml::DcmDRTExposureSequenceInterface::getDiaphragmPosition	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getDiaphragmPosition() [2/2]

bool ml::DcmDRTExposureSequenceInterface::getDiaphragmPosition	(	unsigned long	idx,
		std::string &	parameter ) const

getDiaphragmPositionTag()

std::string ml::DcmDRTExposureSequenceInterface::getDiaphragmPositionTag ( ) const

inline

Definition at line 153 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getDiaphragmPositionTag().

getExposureTime() [1/2]

bool ml::DcmDRTExposureSequenceInterface::getExposureTime	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getExposureTime() [2/2]

bool ml::DcmDRTExposureSequenceInterface::getExposureTime	(	unsigned long	idx,
		std::string &	parameter ) const

getExposureTimeTag()

std::string ml::DcmDRTExposureSequenceInterface::getExposureTimeTag ( ) const

inline

Definition at line 159 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getExposureTimeTag().

getFluenceDataScale() [1/2]

bool ml::DcmDRTExposureSequenceInterface::getFluenceDataScale	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getFluenceDataScale() [2/2]

bool ml::DcmDRTExposureSequenceInterface::getFluenceDataScale	(	unsigned long	idx,
		std::string &	parameter ) const

getFluenceDataScaleTag()

std::string ml::DcmDRTExposureSequenceInterface::getFluenceDataScaleTag ( ) const

inline

Definition at line 165 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getFluenceDataScaleTag().

getFluenceDataSource() [1/2]

bool ml::DcmDRTExposureSequenceInterface::getFluenceDataSource	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getFluenceDataSource() [2/2]

bool ml::DcmDRTExposureSequenceInterface::getFluenceDataSource	(	unsigned long	idx,
		std::string &	parameter ) const

getFluenceDataSourceTag()

std::string ml::DcmDRTExposureSequenceInterface::getFluenceDataSourceTag ( ) const

inline

Definition at line 171 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getFluenceDataSourceTag().

getItem()

DcmDRTExposureSequenceInterface::Item ml::DcmDRTExposureSequenceInterface::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 246 of file mlDcmDRTExposureSequenceInterface.h.

References mlrange_cast().

getKVP() [1/2]

bool ml::DcmDRTExposureSequenceInterface::getKVP	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getKVP() [2/2]

bool ml::DcmDRTExposureSequenceInterface::getKVP	(	unsigned long	idx,
		std::string &	parameter ) const

getKVPTag()

std::string ml::DcmDRTExposureSequenceInterface::getKVPTag ( ) const

inline

Definition at line 177 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getKVPTag().

getMetersetExposure() [1/2]

bool ml::DcmDRTExposureSequenceInterface::getMetersetExposure	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getMetersetExposure() [2/2]

bool ml::DcmDRTExposureSequenceInterface::getMetersetExposure	(	unsigned long	idx,
		std::string &	parameter ) const

getMetersetExposureTag()

std::string ml::DcmDRTExposureSequenceInterface::getMetersetExposureTag ( ) const

inline

Definition at line 183 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getMetersetExposureTag().

getNumberOfBlocks() [1/2]

bool ml::DcmDRTExposureSequenceInterface::getNumberOfBlocks	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getNumberOfBlocks() [2/2]

bool ml::DcmDRTExposureSequenceInterface::getNumberOfBlocks	(	unsigned long	idx,
		std::string &	parameter ) const

getNumberOfBlocksTag()

std::string ml::DcmDRTExposureSequenceInterface::getNumberOfBlocksTag ( ) const

inline

Definition at line 189 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getNumberOfBlocksTag().

getNumberOfItems()

MLint ml::DcmDRTExposureSequenceInterface::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 240 of file mlDcmDRTExposureSequenceInterface.h.

getReferencedFrameNumber() [1/2]

bool ml::DcmDRTExposureSequenceInterface::getReferencedFrameNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedFrameNumber() [2/2]

bool ml::DcmDRTExposureSequenceInterface::getReferencedFrameNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedFrameNumberTag()

std::string ml::DcmDRTExposureSequenceInterface::getReferencedFrameNumberTag ( ) const

inline

Definition at line 195 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getReferencedFrameNumberTag().

getSequence()

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

inline

Return the DRTExposureSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTExposureSequence

Definition at line 228 of file mlDcmDRTExposureSequenceInterface.h.

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

getXRayTubeCurrent() [1/2]

bool ml::DcmDRTExposureSequenceInterface::getXRayTubeCurrent	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getXRayTubeCurrent() [2/2]

bool ml::DcmDRTExposureSequenceInterface::getXRayTubeCurrent	(	unsigned long	idx,
		std::string &	parameter ) const

getXRayTubeCurrentTag()

std::string ml::DcmDRTExposureSequenceInterface::getXRayTubeCurrentTag ( ) const

inline

Definition at line 201 of file mlDcmDRTExposureSequenceInterface.h.

Referenced by DRTExposureSequenceWrapper::getXRayTubeCurrentTag().

hasSequence()

bool ml::DcmDRTExposureSequenceInterface::hasSequence ( ) const

inline

Check if the DRTExposureSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 234 of file mlDcmDRTExposureSequenceInterface.h.

insertItem()

bool ml::DcmDRTExposureSequenceInterface::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 266 of file mlDcmDRTExposureSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTExposureSequenceInterface::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 278 of file mlDcmDRTExposureSequenceInterface.h.

References mlrange_cast().

setApplicatorSequence()

void ml::DcmDRTExposureSequenceInterface::setApplicatorSequence	(	DcmDRTApplicatorSequenceInRTImageModuleInterface	seq,
		unsigned long	idx )

setBeamLimitingDeviceSequence()

void ml::DcmDRTExposureSequenceInterface::setBeamLimitingDeviceSequence	(	DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface	seq,
		unsigned long	idx )

setBlockSequence()

void ml::DcmDRTExposureSequenceInterface::setBlockSequence	(	DcmDRTBlockSequenceInRTImageModuleInterface	seq,
		unsigned long	idx )

setDiaphragmPosition()

bool ml::DcmDRTExposureSequenceInterface::setDiaphragmPosition	(	unsigned long	idx,
		std::string	parameter )

setExposureTime()

bool ml::DcmDRTExposureSequenceInterface::setExposureTime	(	unsigned long	idx,
		std::string	parameter )

setFluenceDataScale()

bool ml::DcmDRTExposureSequenceInterface::setFluenceDataScale	(	unsigned long	idx,
		std::string	parameter )

setFluenceDataSource()

bool ml::DcmDRTExposureSequenceInterface::setFluenceDataSource	(	unsigned long	idx,
		std::string	parameter )

setKVP()

bool ml::DcmDRTExposureSequenceInterface::setKVP	(	unsigned long	idx,
		std::string	parameter )

setMetersetExposure()

bool ml::DcmDRTExposureSequenceInterface::setMetersetExposure	(	unsigned long	idx,
		std::string	parameter )

setNumberOfBlocks()

bool ml::DcmDRTExposureSequenceInterface::setNumberOfBlocks	(	unsigned long	idx,
		std::string	parameter )

setReferencedFrameNumber()

bool ml::DcmDRTExposureSequenceInterface::setReferencedFrameNumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTExposureSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTExposureSequence

Definition at line 222 of file mlDcmDRTExposureSequenceInterface.h.

References mlrange_cast().

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

setXRayTubeCurrent()

bool ml::DcmDRTExposureSequenceInterface::setXRayTubeCurrent	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 290 of file mlDcmDRTExposureSequenceInterface.h.

---

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

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