ml::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface Class Reference

Class to provide access to DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModule. More...

#include <mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModule.

Definition at line 43 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface() [1/3]

ml::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface ( )

inline

Definition at line 83 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface() [3/3]

ml::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References mlrange_cast().

~DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface()

virtual ml::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::~DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::Item & ml::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::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 mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References mlrange_cast().

getItem()

DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::Item ml::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::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 mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::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 mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

getReferencedSOPClassUID() [1/2]

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

getReferencedSOPClassUID() [2/2]

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

getReferencedSOPClassUIDTag()

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

inline

Definition at line 100 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

Referenced by DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleWrapper::getReferencedSOPClassUIDTag().

getReferencedSOPInstanceUID() [1/2]

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

getReferencedSOPInstanceUID() [2/2]

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

getReferencedSOPInstanceUIDTag()

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

inline

Definition at line 106 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

Referenced by DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleWrapper::getReferencedSOPInstanceUIDTag().

getSequence()

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

inline

Return the DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModule

Definition at line 118 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::hasSequence ( ) const

inline

Check if the DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

insertItem()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::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 mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface::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 mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References mlrange_cast().

setReferencedSOPClassUID()

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

setReferencedSOPInstanceUID()

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

setSequence()

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

inline

Set the DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModule

Definition at line 112 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h.

---

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

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