ml::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface Class Reference

Class to provide access to DRTReferencedBolusSequenceInRTIonBeamsSessionRecordModule. More...

#include <mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTReferencedBolusSequenceInRTIonBeamsSessionRecordModule.

Definition at line 43 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface() [1/3]

ml::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface ( )

inline

Definition at line 83 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface() [3/3]

ml::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

~DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface()

virtual ml::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::~DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::Item & ml::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

getAccessoryCode() [1/2]

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

getAccessoryCode() [2/2]

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

getAccessoryCodeTag()

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

inline

Definition at line 100 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Referenced by DRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleWrapper::getAccessoryCodeTag().

getItem()

DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::Item ml::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

getReferencedROINumber() [1/2]

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

getReferencedROINumber() [2/2]

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

getReferencedROINumberTag()

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

inline

Definition at line 106 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Referenced by DRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleWrapper::getReferencedROINumberTag().

getSequence()

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

inline

Return the DRTReferencedBolusSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedBolusSequenceInRTIonBeamsSessionRecordModule

Definition at line 118 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::hasSequence ( ) const

inline

Check if the DRTReferencedBolusSequenceInRTIonBeamsSessionRecordModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

insertItem()

bool ml::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

setAccessoryCode()

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

setReferencedROINumber()

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

setSequence()

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

inline

Set the DRTReferencedBolusSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedBolusSequenceInRTIonBeamsSessionRecordModule

Definition at line 112 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTReferencedBolusSequenceInRTIonBeamsSessionRecordModuleInterface.h.

---

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

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