MeVisLab Toolbox Reference
ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface Class Reference

Class to provide access to DRTReferencedBeamSequenceInRTFractionSchemeModule. More...

#include <mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface ()
 DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface (std::vector< DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface ()
 Default virtual Destructor.
bool getBeamDose (unsigned long idx, std::string &parameter) const
bool getBeamDose (DCMTree::TreePtr item, std::string &parameter) const
std::string getBeamDoseTag () const
bool setBeamDose (unsigned long idx, std::string parameter)
bool getBeamDosePointDepth (unsigned long idx, float &parameter) const
bool getBeamDosePointDepth (DCMTree::TreePtr item, float &parameter) const
std::string getBeamDosePointDepthTag () const
bool setBeamDosePointDepth (unsigned long idx, float parameter)
bool getBeamDosePointEquivalentDepth (unsigned long idx, float &parameter) const
bool getBeamDosePointEquivalentDepth (DCMTree::TreePtr item, float &parameter) const
std::string getBeamDosePointEquivalentDepthTag () const
bool setBeamDosePointEquivalentDepth (unsigned long idx, float parameter)
bool getBeamDosePointSSD (unsigned long idx, float &parameter) const
bool getBeamDosePointSSD (DCMTree::TreePtr item, float &parameter) const
std::string getBeamDosePointSSDTag () const
bool setBeamDosePointSSD (unsigned long idx, float parameter)
bool getBeamDoseSpecificationPoint (unsigned long idx, std::string &parameter) const
bool getBeamDoseSpecificationPoint (DCMTree::TreePtr item, std::string &parameter) const
std::string getBeamDoseSpecificationPointTag () const
bool setBeamDoseSpecificationPoint (unsigned long idx, std::string parameter)
bool getBeamMeterset (unsigned long idx, std::string &parameter) const
bool getBeamMeterset (DCMTree::TreePtr item, std::string &parameter) const
std::string getBeamMetersetTag () const
bool setBeamMeterset (unsigned long idx, std::string parameter)
bool getReferencedBeamNumber (unsigned long idx, std::string &parameter) const
bool getReferencedBeamNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getReferencedBeamNumberTag () const
bool setReferencedBeamNumber (unsigned long idx, std::string parameter)
void setSequence (std::vector< DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item > dcmSequence)
std::vector< DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item getItem (const size_t idx) const
DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item & addItem ()
void addItem (DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

std::vector< DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTReferencedBeamSequenceInRTFractionSchemeModule.

Definition at line 43 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface() [1/3]

ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface ( )
inline

Definition at line 108 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

◆ DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface() [2/3]

ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface ( std::vector< DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item > dcmSequence)
inline

Default Constructor.

Definition at line 111 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

◆ DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface() [3/3]

ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface ( DCMTree::TreePtrVector treePtrSeq)
inline

Definition at line 113 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

◆ ~DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface()

virtual ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::~DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 121 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item & ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::addItem ( )
inline

Adds a new item to the sequence

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

Definition at line 200 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

◆ addItem() [2/2]

void ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::addItem ( DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item newItem)
inline

Definition at line 205 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

◆ getBeamDose() [1/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDose ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBeamDose() [2/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDose ( unsigned long idx,
std::string & parameter ) const

◆ getBeamDosePointDepth() [1/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDosePointDepth ( DCMTree::TreePtr item,
float & parameter ) const

◆ getBeamDosePointDepth() [2/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDosePointDepth ( unsigned long idx,
float & parameter ) const

◆ getBeamDosePointDepthTag()

std::string ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDosePointDepthTag ( ) const
inline

Definition at line 131 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

◆ getBeamDosePointEquivalentDepth() [1/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDosePointEquivalentDepth ( DCMTree::TreePtr item,
float & parameter ) const

◆ getBeamDosePointEquivalentDepth() [2/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDosePointEquivalentDepth ( unsigned long idx,
float & parameter ) const

◆ getBeamDosePointEquivalentDepthTag()

std::string ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDosePointEquivalentDepthTag ( ) const
inline

Definition at line 137 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

◆ getBeamDosePointSSD() [1/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDosePointSSD ( DCMTree::TreePtr item,
float & parameter ) const

◆ getBeamDosePointSSD() [2/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDosePointSSD ( unsigned long idx,
float & parameter ) const

◆ getBeamDosePointSSDTag()

std::string ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDosePointSSDTag ( ) const
inline

Definition at line 143 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

◆ getBeamDoseSpecificationPoint() [1/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDoseSpecificationPoint ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBeamDoseSpecificationPoint() [2/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDoseSpecificationPoint ( unsigned long idx,
std::string & parameter ) const

◆ getBeamDoseSpecificationPointTag()

std::string ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDoseSpecificationPointTag ( ) const
inline

Definition at line 149 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

◆ getBeamDoseTag()

std::string ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamDoseTag ( ) const
inline

Definition at line 125 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

◆ getBeamMeterset() [1/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamMeterset ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBeamMeterset() [2/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamMeterset ( unsigned long idx,
std::string & parameter ) const

◆ getBeamMetersetTag()

std::string ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getBeamMetersetTag ( ) const
inline

Definition at line 155 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

◆ getItem()

DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::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 191 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::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 185 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

◆ getReferencedBeamNumber() [1/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getReferencedBeamNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReferencedBeamNumber() [2/2]

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getReferencedBeamNumber ( unsigned long idx,
std::string & parameter ) const

◆ getReferencedBeamNumberTag()

std::string ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getReferencedBeamNumberTag ( ) const
inline

Definition at line 161 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

◆ getSequence()

std::vector< DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item > ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::getSequence ( ) const
inline

Return the DRTReferencedBeamSequenceInRTFractionSchemeModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTReferencedBeamSequenceInRTFractionSchemeModule

Definition at line 173 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

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

◆ hasSequence()

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::hasSequence ( ) const
inline

Check if the DRTReferencedBeamSequenceInRTFractionSchemeModule is set.

Returns
True if internal pointer is set, False else.

Definition at line 179 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::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 211 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::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 223 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

◆ setBeamDose()

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::setBeamDose ( unsigned long idx,
std::string parameter )

◆ setBeamDosePointDepth()

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::setBeamDosePointDepth ( unsigned long idx,
float parameter )

◆ setBeamDosePointEquivalentDepth()

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::setBeamDosePointEquivalentDepth ( unsigned long idx,
float parameter )

◆ setBeamDosePointSSD()

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::setBeamDosePointSSD ( unsigned long idx,
float parameter )

◆ setBeamDoseSpecificationPoint()

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::setBeamDoseSpecificationPoint ( unsigned long idx,
std::string parameter )

◆ setBeamMeterset()

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::setBeamMeterset ( unsigned long idx,
std::string parameter )

◆ setReferencedBeamNumber()

bool ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::setReferencedBeamNumber ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTReferencedBeamSequenceInRTFractionSchemeModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTReferencedBeamSequenceInRTFractionSchemeModule

Definition at line 167 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

std::vector<DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item> ml::DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::_itemVec
protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 235 of file mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h.

Referenced by addItem(), addItem(), DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface(), DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

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