ml::DcmDRTChannelShieldSequenceInterface Class Reference

Class to provide access to DRTChannelShieldSequence. More...

#include <mlDcmDRTChannelShieldSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTChannelShieldSequenceInterface ()
	DcmDRTChannelShieldSequenceInterface (std::vector< DcmDRTChannelShieldSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTChannelShieldSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTChannelShieldSequenceInterface ()
	Default virtual Destructor.
bool	getChannelShieldID (unsigned long idx, std::string &parameter) const
bool	getChannelShieldID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getChannelShieldIDTag () const
bool	setChannelShieldID (unsigned long idx, std::string parameter)
bool	getChannelShieldName (unsigned long idx, std::string &parameter) const
bool	getChannelShieldName (DCMTree::TreePtr item, std::string &parameter) const
std::string	getChannelShieldNameTag () const
bool	setChannelShieldName (unsigned long idx, std::string parameter)
bool	getChannelShieldNominalThickness (unsigned long idx, std::string &parameter) const
bool	getChannelShieldNominalThickness (DCMTree::TreePtr item, std::string &parameter) const
std::string	getChannelShieldNominalThicknessTag () const
bool	setChannelShieldNominalThickness (unsigned long idx, std::string parameter)
bool	getChannelShieldNominalTransmission (unsigned long idx, std::string &parameter) const
bool	getChannelShieldNominalTransmission (DCMTree::TreePtr item, std::string &parameter) const
std::string	getChannelShieldNominalTransmissionTag () const
bool	setChannelShieldNominalTransmission (unsigned long idx, std::string parameter)
bool	getChannelShieldNumber (unsigned long idx, std::string &parameter) const
bool	getChannelShieldNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getChannelShieldNumberTag () const
bool	setChannelShieldNumber (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	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< DcmDRTChannelShieldSequenceInterface::Item > dcmSequence)
	Set the DRTChannelShieldSequence this interface class provides access to.
std::vector< DcmDRTChannelShieldSequenceInterface::Item >	getSequence () const
	Return the DRTChannelShieldSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTChannelShieldSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTChannelShieldSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTChannelShieldSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTChannelShieldSequenceInterface::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< DcmDRTChannelShieldSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTChannelShieldSequence.

Definition at line 43 of file mlDcmDRTChannelShieldSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTChannelShieldSequenceInterface() [1/3]

ml::DcmDRTChannelShieldSequenceInterface::DcmDRTChannelShieldSequenceInterface ( )

inline

Definition at line 108 of file mlDcmDRTChannelShieldSequenceInterface.h.

DcmDRTChannelShieldSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 111 of file mlDcmDRTChannelShieldSequenceInterface.h.

DcmDRTChannelShieldSequenceInterface() [3/3]

ml::DcmDRTChannelShieldSequenceInterface::DcmDRTChannelShieldSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 113 of file mlDcmDRTChannelShieldSequenceInterface.h.

References mlrange_cast().

~DcmDRTChannelShieldSequenceInterface()

virtual ml::DcmDRTChannelShieldSequenceInterface::~DcmDRTChannelShieldSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 121 of file mlDcmDRTChannelShieldSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTChannelShieldSequenceInterface::Item & ml::DcmDRTChannelShieldSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 200 of file mlDcmDRTChannelShieldSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 205 of file mlDcmDRTChannelShieldSequenceInterface.h.

References mlrange_cast().

getChannelShieldID() [1/2]

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getChannelShieldID() [2/2]

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldID	(	unsigned long	idx,
		std::string &	parameter ) const

getChannelShieldIDTag()

std::string ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldIDTag ( ) const

inline

Definition at line 125 of file mlDcmDRTChannelShieldSequenceInterface.h.

Referenced by DRTChannelShieldSequenceWrapper::getChannelShieldIDTag().

getChannelShieldName() [1/2]

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldName	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getChannelShieldName() [2/2]

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldName	(	unsigned long	idx,
		std::string &	parameter ) const

getChannelShieldNameTag()

std::string ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNameTag ( ) const

inline

Definition at line 131 of file mlDcmDRTChannelShieldSequenceInterface.h.

Referenced by DRTChannelShieldSequenceWrapper::getChannelShieldNameTag().

getChannelShieldNominalThickness() [1/2]

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalThickness	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getChannelShieldNominalThickness() [2/2]

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalThickness	(	unsigned long	idx,
		std::string &	parameter ) const

getChannelShieldNominalThicknessTag()

std::string ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalThicknessTag ( ) const

inline

Definition at line 137 of file mlDcmDRTChannelShieldSequenceInterface.h.

Referenced by DRTChannelShieldSequenceWrapper::getChannelShieldNominalThicknessTag().

getChannelShieldNominalTransmission() [1/2]

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalTransmission	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getChannelShieldNominalTransmission() [2/2]

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalTransmission	(	unsigned long	idx,
		std::string &	parameter ) const

getChannelShieldNominalTransmissionTag()

std::string ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalTransmissionTag ( ) const

inline

Definition at line 143 of file mlDcmDRTChannelShieldSequenceInterface.h.

Referenced by DRTChannelShieldSequenceWrapper::getChannelShieldNominalTransmissionTag().

getChannelShieldNumber() [1/2]

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getChannelShieldNumber() [2/2]

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getChannelShieldNumberTag()

std::string ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNumberTag ( ) const

inline

Definition at line 149 of file mlDcmDRTChannelShieldSequenceInterface.h.

Referenced by DRTChannelShieldSequenceWrapper::getChannelShieldNumberTag().

getItem()

DcmDRTChannelShieldSequenceInterface::Item ml::DcmDRTChannelShieldSequenceInterface::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 191 of file mlDcmDRTChannelShieldSequenceInterface.h.

References mlrange_cast().

getMaterialID() [1/2]

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

getMaterialID() [2/2]

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

getMaterialIDTag()

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

inline

Definition at line 155 of file mlDcmDRTChannelShieldSequenceInterface.h.

Referenced by DRTChannelShieldSequenceWrapper::getMaterialIDTag().

getNumberOfItems()

MLint ml::DcmDRTChannelShieldSequenceInterface::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 185 of file mlDcmDRTChannelShieldSequenceInterface.h.

getReferencedROINumber() [1/2]

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

getReferencedROINumber() [2/2]

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

getReferencedROINumberTag()

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

inline

Definition at line 161 of file mlDcmDRTChannelShieldSequenceInterface.h.

Referenced by DRTChannelShieldSequenceWrapper::getReferencedROINumberTag().

getSequence()

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

inline

Return the DRTChannelShieldSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTChannelShieldSequence

Definition at line 173 of file mlDcmDRTChannelShieldSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTChannelShieldSequenceInterface::hasSequence ( ) const

inline

Check if the DRTChannelShieldSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 179 of file mlDcmDRTChannelShieldSequenceInterface.h.

insertItem()

bool ml::DcmDRTChannelShieldSequenceInterface::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 211 of file mlDcmDRTChannelShieldSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTChannelShieldSequenceInterface::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 223 of file mlDcmDRTChannelShieldSequenceInterface.h.

References mlrange_cast().

setChannelShieldID()

bool ml::DcmDRTChannelShieldSequenceInterface::setChannelShieldID	(	unsigned long	idx,
		std::string	parameter )

setChannelShieldName()

bool ml::DcmDRTChannelShieldSequenceInterface::setChannelShieldName	(	unsigned long	idx,
		std::string	parameter )

setChannelShieldNominalThickness()

bool ml::DcmDRTChannelShieldSequenceInterface::setChannelShieldNominalThickness	(	unsigned long	idx,
		std::string	parameter )

setChannelShieldNominalTransmission()

bool ml::DcmDRTChannelShieldSequenceInterface::setChannelShieldNominalTransmission	(	unsigned long	idx,
		std::string	parameter )

setChannelShieldNumber()

bool ml::DcmDRTChannelShieldSequenceInterface::setChannelShieldNumber	(	unsigned long	idx,
		std::string	parameter )

setMaterialID()

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

setReferencedROINumber()

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

setSequence()

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

inline

Set the DRTChannelShieldSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTChannelShieldSequence

Definition at line 167 of file mlDcmDRTChannelShieldSequenceInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 235 of file mlDcmDRTChannelShieldSequenceInterface.h.

---

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

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