ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface Class Reference

Class to provide access to DRTReferencedBeamSequenceInRTDoseModule. More...

#include <mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTReferencedBeamSequenceInRTDoseModuleInterface ()
	DcmDRTReferencedBeamSequenceInRTDoseModuleInterface (std::vector< DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTReferencedBeamSequenceInRTDoseModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTReferencedBeamSequenceInRTDoseModuleInterface ()
	Default virtual Destructor.
bool	getReferencedBeamNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedBeamNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedBeamNumberTag () const
bool	setReferencedBeamNumber (unsigned long idx, std::string parameter)
bool	getReferencedBrachyApplicationSetupNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedBrachyApplicationSetupNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedBrachyApplicationSetupNumberTag () const
bool	setReferencedBrachyApplicationSetupNumber (unsigned long idx, std::string parameter)
DcmDRTReferencedControlPointSequenceInterface	getReferencedControlPointSequence (unsigned long idx) const
std::string	getReferencedControlPointSequenceTag () const
void	setReferencedControlPointSequence (DcmDRTReferencedControlPointSequenceInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::Item > dcmSequence)
std::vector< DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::Item	getItem (const size_t idx) const
DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::Item &	addItem ()
void	addItem (DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

Protected Attributes
std::vector< DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTReferencedBeamSequenceInRTDoseModule.

Definition at line 44 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedBeamSequenceInRTDoseModuleInterface() [1/3]

ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface ( )

inline

Definition at line 89 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

DcmDRTReferencedBeamSequenceInRTDoseModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 92 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

DcmDRTReferencedBeamSequenceInRTDoseModuleInterface() [3/3]

ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 94 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

~DcmDRTReferencedBeamSequenceInRTDoseModuleInterface()

virtual ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::~DcmDRTReferencedBeamSequenceInRTDoseModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 102 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::Item & ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::addItem ( )

inline

Adds a new item to the sequence

Returns

Return the new item which has been added to the sequence

Definition at line 156 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

getItem()

DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::Item ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::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 147 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::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 141 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

getReferencedBeamNumber() [1/2]

bool ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::getReferencedBeamNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedBeamNumber() [2/2]

bool ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::getReferencedBeamNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedBeamNumberTag()

std::string ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::getReferencedBeamNumberTag ( ) const

inline

Definition at line 106 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

getReferencedBrachyApplicationSetupNumber() [1/2]

bool ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::getReferencedBrachyApplicationSetupNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedBrachyApplicationSetupNumber() [2/2]

bool ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::getReferencedBrachyApplicationSetupNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedBrachyApplicationSetupNumberTag()

std::string ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::getReferencedBrachyApplicationSetupNumberTag ( ) const

inline

Definition at line 112 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

getReferencedControlPointSequence()

DcmDRTReferencedControlPointSequenceInterface ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::getReferencedControlPointSequence

(

unsigned long

idx

)

const

getReferencedControlPointSequenceTag()

std::string ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::getReferencedControlPointSequenceTag ( ) const

inline

Definition at line 117 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

getSequence()

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

inline

Return the DRTReferencedBeamSequenceInRTDoseModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedBeamSequenceInRTDoseModule

Definition at line 129 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::hasSequence ( ) const

inline

Check if the DRTReferencedBeamSequenceInRTDoseModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::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 167 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::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 179 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

setReferencedBeamNumber()

bool ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::setReferencedBeamNumber	(	unsigned long	idx,
		std::string	parameter )

setReferencedBrachyApplicationSetupNumber()

bool ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::setReferencedBrachyApplicationSetupNumber	(	unsigned long	idx,
		std::string	parameter )

setReferencedControlPointSequence()

void ml::DcmDRTReferencedBeamSequenceInRTDoseModuleInterface::setReferencedControlPointSequence	(	DcmDRTReferencedControlPointSequenceInterface	seq,
		unsigned long	idx )

setSequence()

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

inline

Set the DRTReferencedBeamSequenceInRTDoseModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedBeamSequenceInRTDoseModule

Definition at line 123 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTReferencedBeamSequenceInRTDoseModuleInterface.h.

Referenced by addItem(), addItem(), DcmDRTReferencedBeamSequenceInRTDoseModuleInterface(), DcmDRTReferencedBeamSequenceInRTDoseModuleInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

---

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

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