ml::DcmDRTCompensatorSequenceInterface Class Reference

Class to provide access to DRTCompensatorSequence. More...

#include <mlDcmDRTCompensatorSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTCompensatorSequenceInterface ()
	DcmDRTCompensatorSequenceInterface (std::vector< DcmDRTCompensatorSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTCompensatorSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTCompensatorSequenceInterface ()
	Default virtual Destructor.
bool	getAccessoryCode (unsigned long idx, std::string &parameter) const
bool	getAccessoryCode (DCMTree::TreePtr item, std::string &parameter) const
std::string	getAccessoryCodeTag () const
bool	setAccessoryCode (unsigned long idx, std::string parameter)
bool	getCompensatorColumns (unsigned long idx, std::string &parameter) const
bool	getCompensatorColumns (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorColumnsTag () const
bool	setCompensatorColumns (unsigned long idx, std::string parameter)
bool	getCompensatorDivergence (unsigned long idx, std::string &parameter) const
bool	getCompensatorDivergence (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorDivergenceTag () const
bool	setCompensatorDivergence (unsigned long idx, std::string parameter)
bool	getCompensatorID (unsigned long idx, std::string &parameter) const
bool	getCompensatorID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorIDTag () const
bool	setCompensatorID (unsigned long idx, std::string parameter)
bool	getCompensatorMountingPosition (unsigned long idx, std::string &parameter) const
bool	getCompensatorMountingPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorMountingPositionTag () const
bool	setCompensatorMountingPosition (unsigned long idx, std::string parameter)
bool	getCompensatorNumber (unsigned long idx, std::string &parameter) const
bool	getCompensatorNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorNumberTag () const
bool	setCompensatorNumber (unsigned long idx, std::string parameter)
bool	getCompensatorPixelSpacing (unsigned long idx, std::string &parameter) const
bool	getCompensatorPixelSpacing (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorPixelSpacingTag () const
bool	setCompensatorPixelSpacing (unsigned long idx, std::string parameter)
bool	getCompensatorPosition (unsigned long idx, std::string &parameter) const
bool	getCompensatorPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorPositionTag () const
bool	setCompensatorPosition (unsigned long idx, std::string parameter)
bool	getCompensatorRows (unsigned long idx, std::string &parameter) const
bool	getCompensatorRows (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorRowsTag () const
bool	setCompensatorRows (unsigned long idx, std::string parameter)
bool	getCompensatorThicknessData (unsigned long idx, std::string &parameter) const
bool	getCompensatorThicknessData (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorThicknessDataTag () const
bool	setCompensatorThicknessData (unsigned long idx, std::string parameter)
bool	getCompensatorTransmissionData (unsigned long idx, std::string &parameter) const
bool	getCompensatorTransmissionData (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorTransmissionDataTag () const
bool	setCompensatorTransmissionData (unsigned long idx, std::string parameter)
bool	getCompensatorType (unsigned long idx, std::string &parameter) const
bool	getCompensatorType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCompensatorTypeTag () const
bool	setCompensatorType (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	getSourceToCompensatorDistance (unsigned long idx, std::string &parameter) const
bool	getSourceToCompensatorDistance (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceToCompensatorDistanceTag () const
bool	setSourceToCompensatorDistance (unsigned long idx, std::string parameter)
bool	getSourceToCompensatorTrayDistance (unsigned long idx, std::string &parameter) const
bool	getSourceToCompensatorTrayDistance (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSourceToCompensatorTrayDistanceTag () const
bool	setSourceToCompensatorTrayDistance (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTCompensatorSequenceInterface::Item > dcmSequence)
	Set the DRTCompensatorSequence this interface class provides access to.
std::vector< DcmDRTCompensatorSequenceInterface::Item >	getSequence () const
	Return the DRTCompensatorSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTCompensatorSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTCompensatorSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTCompensatorSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTCompensatorSequenceInterface::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< DcmDRTCompensatorSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTCompensatorSequence.

Definition at line 43 of file mlDcmDRTCompensatorSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTCompensatorSequenceInterface() [1/3]

ml::DcmDRTCompensatorSequenceInterface::DcmDRTCompensatorSequenceInterface ( )

inline

Definition at line 148 of file mlDcmDRTCompensatorSequenceInterface.h.

DcmDRTCompensatorSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 151 of file mlDcmDRTCompensatorSequenceInterface.h.

DcmDRTCompensatorSequenceInterface() [3/3]

ml::DcmDRTCompensatorSequenceInterface::DcmDRTCompensatorSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 153 of file mlDcmDRTCompensatorSequenceInterface.h.

References mlrange_cast().

~DcmDRTCompensatorSequenceInterface()

virtual ml::DcmDRTCompensatorSequenceInterface::~DcmDRTCompensatorSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 161 of file mlDcmDRTCompensatorSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTCompensatorSequenceInterface::Item & ml::DcmDRTCompensatorSequenceInterface::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 mlDcmDRTCompensatorSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 293 of file mlDcmDRTCompensatorSequenceInterface.h.

References mlrange_cast().

getAccessoryCode() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getAccessoryCode	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getAccessoryCode() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getAccessoryCode	(	unsigned long	idx,
		std::string &	parameter ) const

getAccessoryCodeTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getAccessoryCodeTag ( ) const

inline

Definition at line 165 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getAccessoryCodeTag().

getCompensatorColumns() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorColumns	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorColumns() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorColumns	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorColumnsTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorColumnsTag ( ) const

inline

Definition at line 171 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorColumnsTag().

getCompensatorDivergence() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorDivergence	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorDivergence() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorDivergence	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorDivergenceTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorDivergenceTag ( ) const

inline

Definition at line 177 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorDivergenceTag().

getCompensatorID() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorID() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorID	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorIDTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorIDTag ( ) const

inline

Definition at line 183 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorIDTag().

getCompensatorMountingPosition() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorMountingPosition	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorMountingPosition() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorMountingPosition	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorMountingPositionTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorMountingPositionTag ( ) const

inline

Definition at line 189 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorMountingPositionTag().

getCompensatorNumber() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorNumber() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorNumberTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorNumberTag ( ) const

inline

Definition at line 195 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorNumberTag().

getCompensatorPixelSpacing() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorPixelSpacing	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorPixelSpacing() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorPixelSpacing	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorPixelSpacingTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorPixelSpacingTag ( ) const

inline

Definition at line 201 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorPixelSpacingTag().

getCompensatorPosition() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorPosition	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorPosition() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorPosition	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorPositionTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorPositionTag ( ) const

inline

Definition at line 207 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorPositionTag().

getCompensatorRows() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorRows	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorRows() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorRows	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorRowsTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorRowsTag ( ) const

inline

Definition at line 213 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorRowsTag().

getCompensatorThicknessData() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorThicknessData	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorThicknessData() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorThicknessData	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorThicknessDataTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorThicknessDataTag ( ) const

inline

Definition at line 219 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorThicknessDataTag().

getCompensatorTransmissionData() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorTransmissionData	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorTransmissionData() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorTransmissionData	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorTransmissionDataTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorTransmissionDataTag ( ) const

inline

Definition at line 225 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorTransmissionDataTag().

getCompensatorType() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCompensatorType() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorType	(	unsigned long	idx,
		std::string &	parameter ) const

getCompensatorTypeTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorTypeTag ( ) const

inline

Definition at line 231 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getCompensatorTypeTag().

getItem()

DcmDRTCompensatorSequenceInterface::Item ml::DcmDRTCompensatorSequenceInterface::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 mlDcmDRTCompensatorSequenceInterface.h.

References mlrange_cast().

getMaterialID() [1/2]

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

getMaterialID() [2/2]

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

getMaterialIDTag()

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

inline

Definition at line 237 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getMaterialIDTag().

getNumberOfItems()

MLint ml::DcmDRTCompensatorSequenceInterface::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 mlDcmDRTCompensatorSequenceInterface.h.

getSequence()

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

inline

Return the DRTCompensatorSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTCompensatorSequence

Definition at line 261 of file mlDcmDRTCompensatorSequenceInterface.h.

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

getSourceToCompensatorDistance() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorDistance	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceToCompensatorDistance() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorDistance	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceToCompensatorDistanceTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorDistanceTag ( ) const

inline

Definition at line 243 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getSourceToCompensatorDistanceTag().

getSourceToCompensatorTrayDistance() [1/2]

bool ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorTrayDistance	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSourceToCompensatorTrayDistance() [2/2]

bool ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorTrayDistance	(	unsigned long	idx,
		std::string &	parameter ) const

getSourceToCompensatorTrayDistanceTag()

std::string ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorTrayDistanceTag ( ) const

inline

Definition at line 249 of file mlDcmDRTCompensatorSequenceInterface.h.

Referenced by DRTCompensatorSequenceWrapper::getSourceToCompensatorTrayDistanceTag().

hasSequence()

bool ml::DcmDRTCompensatorSequenceInterface::hasSequence ( ) const

inline

Check if the DRTCompensatorSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 267 of file mlDcmDRTCompensatorSequenceInterface.h.

insertItem()

bool ml::DcmDRTCompensatorSequenceInterface::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 mlDcmDRTCompensatorSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTCompensatorSequenceInterface::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 mlDcmDRTCompensatorSequenceInterface.h.

References mlrange_cast().

setAccessoryCode()

bool ml::DcmDRTCompensatorSequenceInterface::setAccessoryCode	(	unsigned long	idx,
		std::string	parameter )

setCompensatorColumns()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorColumns	(	unsigned long	idx,
		std::string	parameter )

setCompensatorDivergence()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorDivergence	(	unsigned long	idx,
		std::string	parameter )

setCompensatorID()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorID	(	unsigned long	idx,
		std::string	parameter )

setCompensatorMountingPosition()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorMountingPosition	(	unsigned long	idx,
		std::string	parameter )

setCompensatorNumber()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorNumber	(	unsigned long	idx,
		std::string	parameter )

setCompensatorPixelSpacing()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorPixelSpacing	(	unsigned long	idx,
		std::string	parameter )

setCompensatorPosition()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorPosition	(	unsigned long	idx,
		std::string	parameter )

setCompensatorRows()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorRows	(	unsigned long	idx,
		std::string	parameter )

setCompensatorThicknessData()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorThicknessData	(	unsigned long	idx,
		std::string	parameter )

setCompensatorTransmissionData()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorTransmissionData	(	unsigned long	idx,
		std::string	parameter )

setCompensatorType()

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorType	(	unsigned long	idx,
		std::string	parameter )

setMaterialID()

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

setSequence()

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

inline

Set the DRTCompensatorSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTCompensatorSequence

Definition at line 255 of file mlDcmDRTCompensatorSequenceInterface.h.

References mlrange_cast().

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

setSourceToCompensatorDistance()

bool ml::DcmDRTCompensatorSequenceInterface::setSourceToCompensatorDistance	(	unsigned long	idx,
		std::string	parameter )

setSourceToCompensatorTrayDistance()

bool ml::DcmDRTCompensatorSequenceInterface::setSourceToCompensatorTrayDistance	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 323 of file mlDcmDRTCompensatorSequenceInterface.h.

---

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

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