ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface Class Reference

Class to provide access to DRTReferencedDoseReferenceSequenceInRTIonBeamsModule. More...

#include <mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface ()
	DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface (std::vector< DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface ()
	Default virtual Destructor.
bool	getCumulativeDoseReferenceCoefficient (unsigned long idx, std::string &parameter) const
bool	getCumulativeDoseReferenceCoefficient (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCumulativeDoseReferenceCoefficientTag () const
bool	setCumulativeDoseReferenceCoefficient (unsigned long idx, std::string parameter)
bool	getReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedDoseReferenceNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedDoseReferenceNumberTag () const
bool	setReferencedDoseReferenceNumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
	Set the DRTReferencedDoseReferenceSequenceInRTIonBeamsModule this interface class provides access to.
std::vector< DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::Item >	getSequence () const
	Return the DRTReferencedDoseReferenceSequenceInRTIonBeamsModule this interface class provides access to.
bool	hasSequence () const
	Check if the DRTReferencedDoseReferenceSequenceInRTIonBeamsModule is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::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< DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTReferencedDoseReferenceSequenceInRTIonBeamsModule.

Definition at line 43 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface() [1/3]

ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface ( )

inline

Definition at line 83 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface() [3/3]

ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

~DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface()

virtual ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::~DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::Item & ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 145 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

getCumulativeDoseReferenceCoefficient() [1/2]

bool ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::getCumulativeDoseReferenceCoefficient	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCumulativeDoseReferenceCoefficient() [2/2]

bool ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::getCumulativeDoseReferenceCoefficient	(	unsigned long	idx,
		std::string &	parameter ) const

getCumulativeDoseReferenceCoefficientTag()

std::string ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::getCumulativeDoseReferenceCoefficientTag ( ) const

inline

Definition at line 100 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTReferencedDoseReferenceSequenceInRTIonBeamsModuleWrapper::getCumulativeDoseReferenceCoefficientTag().

getItem()

DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::Item ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::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 136 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::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 130 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

getReferencedDoseReferenceNumber() [1/2]

bool ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::getReferencedDoseReferenceNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedDoseReferenceNumber() [2/2]

bool ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::getReferencedDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedDoseReferenceNumberTag()

std::string ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::getReferencedDoseReferenceNumberTag ( ) const

inline

Definition at line 106 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTReferencedDoseReferenceSequenceInRTIonBeamsModuleWrapper::getReferencedDoseReferenceNumberTag().

getSequence()

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

inline

Return the DRTReferencedDoseReferenceSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedDoseReferenceSequenceInRTIonBeamsModule

Definition at line 118 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::hasSequence ( ) const

inline

Check if the DRTReferencedDoseReferenceSequenceInRTIonBeamsModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

insertItem()

bool ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::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 156 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::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 168 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

setCumulativeDoseReferenceCoefficient()

bool ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::setCumulativeDoseReferenceCoefficient	(	unsigned long	idx,
		std::string	parameter )

setReferencedDoseReferenceNumber()

bool ml::DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface::setReferencedDoseReferenceNumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTReferencedDoseReferenceSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedDoseReferenceSequenceInRTIonBeamsModule

Definition at line 112 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface.h.

---

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

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