ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface Class Reference

Class to provide access to DRTReferencedBolusSequenceInRTBeamsModule. More...

#include <mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ()
	DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface (std::vector< DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ()
	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	getBolusDescription (unsigned long idx, std::string &parameter) const
bool	getBolusDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string	getBolusDescriptionTag () const
bool	setBolusDescription (unsigned long idx, std::string parameter)
bool	getBolusID (unsigned long idx, std::string &parameter) const
bool	getBolusID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getBolusIDTag () const
bool	setBolusID (unsigned long idx, std::string parameter)
bool	getReferencedROINumber (unsigned long idx, std::string &parameter) const
bool	getReferencedROINumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedROINumberTag () const
bool	setReferencedROINumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item > dcmSequence)
std::vector< DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item	getItem (const size_t idx) const
DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item &	addItem ()
void	addItem (DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTReferencedBolusSequenceInRTBeamsModule.

Definition at line 43 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface() [1/3]

ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ( )

inline

Definition at line 93 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface() [3/3]

ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

~DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface()

virtual ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::~DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item & ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::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 mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

getAccessoryCode() [1/2]

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

getAccessoryCode() [2/2]

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

getAccessoryCodeTag()

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

inline

Definition at line 110 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

getBolusDescription() [1/2]

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getBolusDescription() [2/2]

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusDescription	(	unsigned long	idx,
		std::string &	parameter ) const

getBolusDescriptionTag()

std::string ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusDescriptionTag ( ) const

inline

Definition at line 116 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

getBolusID() [1/2]

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getBolusID() [2/2]

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusID	(	unsigned long	idx,
		std::string &	parameter ) const

getBolusIDTag()

std::string ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusIDTag ( ) const

inline

Definition at line 122 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

getItem()

DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::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 mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::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 mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

getReferencedROINumber() [1/2]

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getReferencedROINumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedROINumber() [2/2]

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getReferencedROINumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedROINumberTag()

std::string ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getReferencedROINumberTag ( ) const

inline

Definition at line 128 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

getSequence()

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

inline

Return the DRTReferencedBolusSequenceInRTBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedBolusSequenceInRTBeamsModule

Definition at line 140 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::hasSequence ( ) const

inline

Check if the DRTReferencedBolusSequenceInRTBeamsModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::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 mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::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 mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

setAccessoryCode()

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

setBolusDescription()

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::setBolusDescription	(	unsigned long	idx,
		std::string	parameter )

setBolusID()

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::setBolusID	(	unsigned long	idx,
		std::string	parameter )

setReferencedROINumber()

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::setReferencedROINumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTReferencedBolusSequenceInRTBeamsModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedBolusSequenceInRTBeamsModule

Definition at line 134 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

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