ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface Class Reference

Class to provide access to DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule. More...

#include <mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface ()
	DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface (std::vector< DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface ()
	Default virtual Destructor.
bool	getBrachyApplicationSetupDose (unsigned long idx, std::string &parameter) const
bool	getBrachyApplicationSetupDose (DCMTree::TreePtr item, std::string &parameter) const
std::string	getBrachyApplicationSetupDoseTag () const
bool	setBrachyApplicationSetupDose (unsigned long idx, std::string parameter)
bool	getBrachyApplicationSetupDoseSpecificationPoint (unsigned long idx, std::string &parameter) const
bool	getBrachyApplicationSetupDoseSpecificationPoint (DCMTree::TreePtr item, std::string &parameter) const
std::string	getBrachyApplicationSetupDoseSpecificationPointTag () const
bool	setBrachyApplicationSetupDoseSpecificationPoint (unsigned long idx, std::string parameter)
bool	getReferencedBrachyApplicationSetupNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedBrachyApplicationSetupNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedBrachyApplicationSetupNumberTag () const
bool	setReferencedBrachyApplicationSetupNumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::Item > dcmSequence)
	Set the DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule this interface class provides access to.
std::vector< DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::Item >	getSequence () const
	Return the DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule this interface class provides access to.
bool	hasSequence () const
	Check if the DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::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< DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule.

Definition at line 43 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface() [1/3]

ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface ( )

inline

Definition at line 88 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface() [3/3]

ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

References mlrange_cast().

~DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface()

virtual ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::~DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::Item & ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::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 mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

References mlrange_cast().

getBrachyApplicationSetupDose() [1/2]

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::getBrachyApplicationSetupDose	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getBrachyApplicationSetupDose() [2/2]

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::getBrachyApplicationSetupDose	(	unsigned long	idx,
		std::string &	parameter ) const

getBrachyApplicationSetupDoseSpecificationPoint() [1/2]

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::getBrachyApplicationSetupDoseSpecificationPoint	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getBrachyApplicationSetupDoseSpecificationPoint() [2/2]

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::getBrachyApplicationSetupDoseSpecificationPoint	(	unsigned long	idx,
		std::string &	parameter ) const

getBrachyApplicationSetupDoseSpecificationPointTag()

std::string ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::getBrachyApplicationSetupDoseSpecificationPointTag ( ) const

inline

Definition at line 111 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

Referenced by DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleWrapper::getBrachyApplicationSetupDoseSpecificationPointTag().

getBrachyApplicationSetupDoseTag()

std::string ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::getBrachyApplicationSetupDoseTag ( ) const

inline

Definition at line 105 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

Referenced by DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleWrapper::getBrachyApplicationSetupDoseTag().

getItem()

DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::Item ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::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 mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::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 mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

getReferencedBrachyApplicationSetupNumber() [1/2]

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::getReferencedBrachyApplicationSetupNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedBrachyApplicationSetupNumber() [2/2]

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::getReferencedBrachyApplicationSetupNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedBrachyApplicationSetupNumberTag()

std::string ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::getReferencedBrachyApplicationSetupNumberTag ( ) const

inline

Definition at line 117 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

Referenced by DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleWrapper::getReferencedBrachyApplicationSetupNumberTag().

getSequence()

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

inline

Return the DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule

Definition at line 129 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::hasSequence ( ) const

inline

Check if the DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

insertItem()

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::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 mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::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 mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

References mlrange_cast().

setBrachyApplicationSetupDose()

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::setBrachyApplicationSetupDose	(	unsigned long	idx,
		std::string	parameter )

setBrachyApplicationSetupDoseSpecificationPoint()

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::setBrachyApplicationSetupDoseSpecificationPoint	(	unsigned long	idx,
		std::string	parameter )

setReferencedBrachyApplicationSetupNumber()

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface::setReferencedBrachyApplicationSetupNumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule

Definition at line 123 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h.

---

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

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