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. More...
	DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface ()
	Default virtual Destructor. More...
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)
	Set the DRTReferencedReferenceImageSequenceInRTBeamsModule this interface class provides access to. More...
std::vector< DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item >	getSequence () const
	Return the DRTReferencedReferenceImageSequenceInRTBeamsModule this interface class provides access to. More...
bool	hasSequence () const
	Check if the DRTReferencedReferenceImageSequenceInRTBeamsModule is set. More...
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of. More...
DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position. More...
DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item &	addItem ()
	Adds a new item to the sequence. More...
void	addItem (DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
	Insert an item at the indicated position. More...
bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence. More...

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

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.

DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface() [3/3]

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

inline

Definition at line 103 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

~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.

addItem() [2/2]

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

inline

Definition at line 183 of file mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h.

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.

Referenced by DRTReferencedReferenceImageSequenceInRTBeamsModuleWrapper::getEndCumulativeMetersetWeightTag().

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.

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.

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.

Referenced by DRTReferencedReferenceImageSequenceInRTBeamsModuleWrapper::getReferencedSOPClassUIDTag().

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.

Referenced by DRTReferencedReferenceImageSequenceInRTBeamsModuleWrapper::getReferencedSOPInstanceUIDTag().

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.

Referenced by DRTReferencedReferenceImageSequenceInRTBeamsModuleWrapper::getReferenceImageNumberTag().

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.

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.

Referenced by DRTReferencedReferenceImageSequenceInRTBeamsModuleWrapper::getStartCumulativeMetersetWeightTag().

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.

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.

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.

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.

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

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.

---

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

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