ml::DcmDRTReferencedFractionGroupSequenceInterface Class Reference

Class to provide access to DRTReferencedFractionGroupSequence. More...

#include <mlDcmDRTReferencedFractionGroupSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTReferencedFractionGroupSequenceInterface ()
	DcmDRTReferencedFractionGroupSequenceInterface (std::vector< DcmDRTReferencedFractionGroupSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTReferencedFractionGroupSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTReferencedFractionGroupSequenceInterface ()
	Default virtual Destructor.
bool	getReferencedFractionGroupNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedFractionGroupNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedFractionGroupNumberTag () const
bool	setReferencedFractionGroupNumber (unsigned long idx, std::string parameter)
DcmDRTReferencedBeamSequenceInRTDoseModuleInterface	getReferencedBeamSequence (unsigned long idx) const
std::string	getReferencedBeamSequenceTag () const
void	setReferencedBeamSequence (DcmDRTReferencedBeamSequenceInRTDoseModuleInterface seq, unsigned long idx)
DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface	getReferencedBrachyApplicationSetupSequence (unsigned long idx) const
std::string	getReferencedBrachyApplicationSetupSequenceTag () const
void	setReferencedBrachyApplicationSetupSequence (DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTReferencedFractionGroupSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTReferencedFractionGroupSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTReferencedFractionGroupSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTReferencedFractionGroupSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTReferencedFractionGroupSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTReferencedFractionGroupSequence.

Definition at line 45 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedFractionGroupSequenceInterface() [1/3]

ml::DcmDRTReferencedFractionGroupSequenceInterface::DcmDRTReferencedFractionGroupSequenceInterface ( )

inline

Definition at line 90 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

DcmDRTReferencedFractionGroupSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 93 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

DcmDRTReferencedFractionGroupSequenceInterface() [3/3]

ml::DcmDRTReferencedFractionGroupSequenceInterface::DcmDRTReferencedFractionGroupSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 95 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

~DcmDRTReferencedFractionGroupSequenceInterface()

virtual ml::DcmDRTReferencedFractionGroupSequenceInterface::~DcmDRTReferencedFractionGroupSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 103 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedFractionGroupSequenceInterface::Item & ml::DcmDRTReferencedFractionGroupSequenceInterface::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 mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

getItem()

DcmDRTReferencedFractionGroupSequenceInterface::Item ml::DcmDRTReferencedFractionGroupSequenceInterface::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 mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTReferencedFractionGroupSequenceInterface::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 mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

getReferencedBeamSequence()

DcmDRTReferencedBeamSequenceInRTDoseModuleInterface ml::DcmDRTReferencedFractionGroupSequenceInterface::getReferencedBeamSequence

(

unsigned long

idx

)

const

getReferencedBeamSequenceTag()

std::string ml::DcmDRTReferencedFractionGroupSequenceInterface::getReferencedBeamSequenceTag ( ) const

inline

Definition at line 112 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

getReferencedBrachyApplicationSetupSequence()

DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface ml::DcmDRTReferencedFractionGroupSequenceInterface::getReferencedBrachyApplicationSetupSequence

(

unsigned long

idx

)

const

getReferencedBrachyApplicationSetupSequenceTag()

std::string ml::DcmDRTReferencedFractionGroupSequenceInterface::getReferencedBrachyApplicationSetupSequenceTag ( ) const

inline

Definition at line 117 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

getReferencedFractionGroupNumber() [1/2]

bool ml::DcmDRTReferencedFractionGroupSequenceInterface::getReferencedFractionGroupNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedFractionGroupNumber() [2/2]

bool ml::DcmDRTReferencedFractionGroupSequenceInterface::getReferencedFractionGroupNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedFractionGroupNumberTag()

std::string ml::DcmDRTReferencedFractionGroupSequenceInterface::getReferencedFractionGroupNumberTag ( ) const

inline

Definition at line 107 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

getSequence()

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

inline

Return the DRTReferencedFractionGroupSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedFractionGroupSequence

Definition at line 129 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTReferencedFractionGroupSequenceInterface::hasSequence ( ) const

inline

Check if the DRTReferencedFractionGroupSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTReferencedFractionGroupSequenceInterface::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 mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTReferencedFractionGroupSequenceInterface::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 mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

setReferencedBeamSequence()

void ml::DcmDRTReferencedFractionGroupSequenceInterface::setReferencedBeamSequence	(	DcmDRTReferencedBeamSequenceInRTDoseModuleInterface	seq,
		unsigned long	idx )

setReferencedBrachyApplicationSetupSequence()

void ml::DcmDRTReferencedFractionGroupSequenceInterface::setReferencedBrachyApplicationSetupSequence	(	DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface	seq,
		unsigned long	idx )

setReferencedFractionGroupNumber()

bool ml::DcmDRTReferencedFractionGroupSequenceInterface::setReferencedFractionGroupNumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTReferencedFractionGroupSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedFractionGroupSequence

Definition at line 123 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTReferencedFractionGroupSequenceInterface.h.

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