Class to provide access to DRTApplicatorSequenceInRTIonBeamsModule. More...

#include <mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface ()
	DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface (std::vector< DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface ()
	Default virtual Destructor.
bool	getAccessoryCode (unsigned long idx, std::string &parameter) const
bool	getAccessoryCode (DCMTree::TreePtr item, std::string &parameter) const
std::string	getAccessoryCodeTag () const
bool	setAccessoryCode (unsigned long idx, std::string parameter)
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< DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
std::vector< DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item	getItem (const size_t idx) const
DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item &	addItem ()
void	addItem (DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTApplicatorSequenceInRTIonBeamsModule.

Definition at line 43 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface() [1/3]

ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface ( )

inline

Definition at line 93 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

◆ DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

◆ DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface() [3/3]

ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

◆ ~DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface()

virtual ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::~DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item & ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::addItem ( )

inline

Adds a new item to the sequence

Returns: Return the new item which has been added to the sequence

Definition at line 167 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

◆ getAccessoryCode() [1/2]

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::getAccessoryCode	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getAccessoryCode() [2/2]

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::getAccessoryCode	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getAccessoryCodeTag()

std::string ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::getAccessoryCodeTag ( ) const

inline

Definition at line 110 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

◆ getApplicatorDescription() [1/2]

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

◆ getApplicatorDescription() [2/2]

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

◆ getApplicatorDescriptionTag()

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

inline

Definition at line 116 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

◆ getApplicatorID() [1/2]

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

◆ getApplicatorID() [2/2]

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

◆ getApplicatorIDTag()

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

inline

Definition at line 122 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

◆ getApplicatorType() [1/2]

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

◆ getApplicatorType() [2/2]

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

◆ getApplicatorTypeTag()

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

inline

Definition at line 128 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

◆ getItem()

DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::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 158 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::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 152 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

◆ getSequence()

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

inline

Return the DRTApplicatorSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence Pointer to DRTApplicatorSequenceInRTIonBeamsModule

Definition at line 140 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

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

◆ hasSequence()

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::hasSequence ( ) const

inline

Check if the DRTApplicatorSequenceInRTIonBeamsModule is set.

Returns: True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::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 178 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::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 190 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

◆ setAccessoryCode()

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::setAccessoryCode	(	unsigned long	idx,
		std::string	parameter )

◆ setApplicatorDescription()

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

◆ setApplicatorID()

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

◆ setApplicatorType()

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

◆ setSequence()

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

inline

Set the DRTApplicatorSequenceInRTIonBeamsModule this interface class provides access to.

Parameters

dcmSequence Pointer to DRTApplicatorSequenceInRTIonBeamsModule

Definition at line 134 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h.

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

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface() [1/3]

◆ DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface() [2/3]

◆ DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface() [3/3]

◆ ~DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface()

Member Function Documentation

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ getAccessoryCode() [1/2]

◆ getAccessoryCode() [2/2]

◆ getAccessoryCodeTag()

◆ getApplicatorDescription() [1/2]

◆ getApplicatorDescription() [2/2]

◆ getApplicatorDescriptionTag()

◆ getApplicatorID() [1/2]

◆ getApplicatorID() [2/2]

◆ getApplicatorIDTag()

◆ getApplicatorType() [1/2]

◆ getApplicatorType() [2/2]

◆ getApplicatorTypeTag()

◆ getItem()

◆ getNumberOfItems()

◆ getSequence()

◆ hasSequence()

◆ insertItem()

◆ removeItem()

◆ setAccessoryCode()

◆ setApplicatorDescription()

◆ setApplicatorID()

◆ setApplicatorType()

◆ setSequence()

Member Data Documentation

◆ _itemVec