ml::DcmDRTApplicatorSequenceInRTImageModuleInterface Class Reference

Class to provide access to DRTApplicatorSequenceInRTImageModule. More...

#include <mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTApplicatorSequenceInRTImageModuleInterface ()
	DcmDRTApplicatorSequenceInRTImageModuleInterface (std::vector< DcmDRTApplicatorSequenceInRTImageModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTApplicatorSequenceInRTImageModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTApplicatorSequenceInRTImageModuleInterface ()
	Default virtual Destructor.
bool	getApplicatorDescription (unsigned long idx, std::string &parameter) const
bool	getApplicatorDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string	getApplicatorDescriptionTag () const
bool	setApplicatorDescription (unsigned long idx, std::string parameter)
bool	getApplicatorID (unsigned long idx, std::string &parameter) const
bool	getApplicatorID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getApplicatorIDTag () const
bool	setApplicatorID (unsigned long idx, std::string parameter)
bool	getApplicatorType (unsigned long idx, std::string &parameter) const
bool	getApplicatorType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getApplicatorTypeTag () const
bool	setApplicatorType (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTApplicatorSequenceInRTImageModuleInterface::Item > dcmSequence)
std::vector< DcmDRTApplicatorSequenceInRTImageModuleInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTApplicatorSequenceInRTImageModuleInterface::Item	getItem (const size_t idx) const
DcmDRTApplicatorSequenceInRTImageModuleInterface::Item &	addItem ()
void	addItem (DcmDRTApplicatorSequenceInRTImageModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTApplicatorSequenceInRTImageModule.

Definition at line 43 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTApplicatorSequenceInRTImageModuleInterface() [1/3]

ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::DcmDRTApplicatorSequenceInRTImageModuleInterface ( )

inline

Definition at line 88 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

DcmDRTApplicatorSequenceInRTImageModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

DcmDRTApplicatorSequenceInRTImageModuleInterface() [3/3]

ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::DcmDRTApplicatorSequenceInRTImageModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

~DcmDRTApplicatorSequenceInRTImageModuleInterface()

virtual ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::~DcmDRTApplicatorSequenceInRTImageModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTApplicatorSequenceInRTImageModuleInterface::Item & ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::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 mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

getApplicatorDescription() [1/2]

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::getApplicatorDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getApplicatorDescription() [2/2]

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::getApplicatorDescription	(	unsigned long	idx,
		std::string &	parameter ) const

getApplicatorDescriptionTag()

std::string ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::getApplicatorDescriptionTag ( ) const

inline

Definition at line 105 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

getApplicatorID() [1/2]

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::getApplicatorID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getApplicatorID() [2/2]

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::getApplicatorID	(	unsigned long	idx,
		std::string &	parameter ) const

getApplicatorIDTag()

std::string ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::getApplicatorIDTag ( ) const

inline

Definition at line 111 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

getApplicatorType() [1/2]

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::getApplicatorType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getApplicatorType() [2/2]

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::getApplicatorType	(	unsigned long	idx,
		std::string &	parameter ) const

getApplicatorTypeTag()

std::string ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::getApplicatorTypeTag ( ) const

inline

Definition at line 117 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

getItem()

DcmDRTApplicatorSequenceInRTImageModuleInterface::Item ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::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 mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::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 mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

getSequence()

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

inline

Return the DRTApplicatorSequenceInRTImageModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTApplicatorSequenceInRTImageModule

Definition at line 129 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::hasSequence ( ) const

inline

Check if the DRTApplicatorSequenceInRTImageModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::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 mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::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 mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

setApplicatorDescription()

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::setApplicatorDescription	(	unsigned long	idx,
		std::string	parameter )

setApplicatorID()

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::setApplicatorID	(	unsigned long	idx,
		std::string	parameter )

setApplicatorType()

bool ml::DcmDRTApplicatorSequenceInRTImageModuleInterface::setApplicatorType	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTApplicatorSequenceInRTImageModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTApplicatorSequenceInRTImageModule

Definition at line 123 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h.

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