ml::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface Class Reference

Class to provide access to DRTReferencedReferenceImageSequenceInRTIonBeamsModule. More...

#include <mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTReferencedReferenceImageSequenceInRTIonBeamsModule.

Definition at line 43 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface() [1/3]

ml::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface ( )

inline

Definition at line 88 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface() [3/3]

ml::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

~DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface()

virtual ml::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::~DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::Item& ml::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::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 mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

getItem()

DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::Item ml::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::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 mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

getNumberOfItems()

MLint ml::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::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 mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

getReferencedSOPClassUID() [1/2]

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

getReferencedSOPClassUID() [2/2]

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

getReferencedSOPClassUIDTag()

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

inline

Definition at line 111 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTReferencedReferenceImageSequenceInRTIonBeamsModuleWrapper::getReferencedSOPClassUIDTag().

getReferencedSOPInstanceUID() [1/2]

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

getReferencedSOPInstanceUID() [2/2]

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

getReferencedSOPInstanceUIDTag()

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

inline

Definition at line 117 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTReferencedReferenceImageSequenceInRTIonBeamsModuleWrapper::getReferencedSOPInstanceUIDTag().

getReferenceImageNumber() [1/2]

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

getReferenceImageNumber() [2/2]

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

getReferenceImageNumberTag()

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

inline

Definition at line 105 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

Referenced by DRTReferencedReferenceImageSequenceInRTIonBeamsModuleWrapper::getReferenceImageNumberTag().

getSequence()

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

inline

Return the DRTReferencedReferenceImageSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedReferenceImageSequenceInRTIonBeamsModule

Definition at line 129 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::hasSequence ( ) const

inline

Check if the DRTReferencedReferenceImageSequenceInRTIonBeamsModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

insertItem()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::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 mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

removeItem()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface::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 mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

setReferencedSOPClassUID()

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

setReferencedSOPInstanceUID()

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

setReferenceImageNumber()

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

setSequence()

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

inline

Set the DRTReferencedReferenceImageSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedReferenceImageSequenceInRTIonBeamsModule

Definition at line 123 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTReferencedReferenceImageSequenceInRTIonBeamsModuleInterface.h.

---

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

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