ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface Class Reference

Class to provide access to DRTReferencedReferenceImageSequenceInRTBeamsModule. More...

#include <mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface ()
	DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface (std::vector< DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface ()
	Default virtual Destructor.
bool	getEndCumulativeMetersetWeight (unsigned long idx, std::string &parameter) const
bool	getEndCumulativeMetersetWeight (DCMTree::TreePtr item, std::string &parameter) const
std::string	getEndCumulativeMetersetWeightTag () const
bool	setEndCumulativeMetersetWeight (unsigned long idx, std::string parameter)
bool	getReferenceImageNumber (unsigned long idx, std::string &parameter) const
bool	getReferenceImageNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferenceImageNumberTag () const
bool	setReferenceImageNumber (unsigned long idx, std::string parameter)
bool	getReferencedSOPClassUID (unsigned long idx, std::string &parameter) const
bool	getReferencedSOPClassUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedSOPClassUIDTag () const
bool	setReferencedSOPClassUID (unsigned long idx, std::string parameter)
bool	getReferencedSOPInstanceUID (unsigned long idx, std::string &parameter) const
bool	getReferencedSOPInstanceUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedSOPInstanceUIDTag () const
bool	setReferencedSOPInstanceUID (unsigned long idx, std::string parameter)
bool	getStartCumulativeMetersetWeight (unsigned long idx, std::string &parameter) const
bool	getStartCumulativeMetersetWeight (DCMTree::TreePtr item, std::string &parameter) const
std::string	getStartCumulativeMetersetWeightTag () const
bool	setStartCumulativeMetersetWeight (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item > dcmSequence)
std::vector< DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item	getItem (const size_t idx) const
DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item &	addItem ()
void	addItem (DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTReferencedReferenceImageSequenceInRTBeamsModule.

Definition at line 43 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface() [1/3]

ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface ( )

inline

Definition at line 98 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 101 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface() [3/3]

ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 103 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

~DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface()

virtual ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::~DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 111 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item & ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::addItem ( )

inline

Adds a new item to the sequence

Returns

Return the new item which has been added to the sequence

Definition at line 178 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 183 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

getEndCumulativeMetersetWeight() [1/2]

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getEndCumulativeMetersetWeight	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getEndCumulativeMetersetWeight() [2/2]

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getEndCumulativeMetersetWeight	(	unsigned long	idx,
		std::string &	parameter ) const

getEndCumulativeMetersetWeightTag()

std::string ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getEndCumulativeMetersetWeightTag ( ) const

inline

Definition at line 115 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

getItem()

DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::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 169 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::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 163 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

getReferencedSOPClassUID() [1/2]

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getReferencedSOPClassUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedSOPClassUID() [2/2]

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getReferencedSOPClassUID	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedSOPClassUIDTag()

std::string ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getReferencedSOPClassUIDTag ( ) const

inline

Definition at line 127 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

getReferencedSOPInstanceUID() [1/2]

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getReferencedSOPInstanceUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedSOPInstanceUID() [2/2]

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getReferencedSOPInstanceUID	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedSOPInstanceUIDTag()

std::string ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getReferencedSOPInstanceUIDTag ( ) const

inline

Definition at line 133 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

getReferenceImageNumber() [1/2]

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getReferenceImageNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferenceImageNumber() [2/2]

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getReferenceImageNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferenceImageNumberTag()

std::string ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getReferenceImageNumberTag ( ) const

inline

Definition at line 121 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

getSequence()

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

inline

Return the DRTReferencedReferenceImageSequenceInRTBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedReferenceImageSequenceInRTBeamsModule

Definition at line 151 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

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

getStartCumulativeMetersetWeight() [1/2]

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getStartCumulativeMetersetWeight	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getStartCumulativeMetersetWeight() [2/2]

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getStartCumulativeMetersetWeight	(	unsigned long	idx,
		std::string &	parameter ) const

getStartCumulativeMetersetWeightTag()

std::string ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::getStartCumulativeMetersetWeightTag ( ) const

inline

Definition at line 139 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

hasSequence()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::hasSequence ( ) const

inline

Check if the DRTReferencedReferenceImageSequenceInRTBeamsModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 157 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::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 189 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::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 201 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

setEndCumulativeMetersetWeight()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::setEndCumulativeMetersetWeight	(	unsigned long	idx,
		std::string	parameter )

setReferencedSOPClassUID()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::setReferencedSOPClassUID	(	unsigned long	idx,
		std::string	parameter )

setReferencedSOPInstanceUID()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::setReferencedSOPInstanceUID	(	unsigned long	idx,
		std::string	parameter )

setReferenceImageNumber()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::setReferenceImageNumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTReferencedReferenceImageSequenceInRTBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedReferenceImageSequenceInRTBeamsModule

Definition at line 145 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

References _itemVec.

setStartCumulativeMetersetWeight()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::setStartCumulativeMetersetWeight	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 213 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

Referenced by addItem(), addItem(), DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface(), DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface(), 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/mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h