MeVisLab Toolbox Reference
ml::DcmDRTBeamSequenceInterface Class Reference

Class to provide access to DRTBeamSequence. More...

#include <mlDcmDRTBeamSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTBeamSequenceInterface ()
 DcmDRTBeamSequenceInterface (std::vector< DcmDRTBeamSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTBeamSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTBeamSequenceInterface ()
 Default virtual Destructor.
bool getBeamDescription (unsigned long idx, std::string &parameter) const
bool getBeamDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string getBeamDescriptionTag () const
bool setBeamDescription (unsigned long idx, std::string parameter)
bool getBeamName (unsigned long idx, std::string &parameter) const
bool getBeamName (DCMTree::TreePtr item, std::string &parameter) const
std::string getBeamNameTag () const
bool setBeamName (unsigned long idx, std::string parameter)
bool getBeamNumber (unsigned long idx, std::string &parameter) const
bool getBeamNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getBeamNumberTag () const
bool setBeamNumber (unsigned long idx, std::string parameter)
bool getBeamType (unsigned long idx, std::string &parameter) const
bool getBeamType (DCMTree::TreePtr item, std::string &parameter) const
std::string getBeamTypeTag () const
bool setBeamType (unsigned long idx, std::string parameter)
bool getDeviceSerialNumber (unsigned long idx, std::string &parameter) const
bool getDeviceSerialNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getDeviceSerialNumberTag () const
bool setDeviceSerialNumber (unsigned long idx, std::string parameter)
bool getFinalCumulativeMetersetWeight (unsigned long idx, std::string &parameter) const
bool getFinalCumulativeMetersetWeight (DCMTree::TreePtr item, std::string &parameter) const
std::string getFinalCumulativeMetersetWeightTag () const
bool setFinalCumulativeMetersetWeight (unsigned long idx, std::string parameter)
bool getHighDoseTechniqueType (unsigned long idx, std::string &parameter) const
bool getHighDoseTechniqueType (DCMTree::TreePtr item, std::string &parameter) const
std::string getHighDoseTechniqueTypeTag () const
bool setHighDoseTechniqueType (unsigned long idx, std::string parameter)
bool getInstitutionAddress (unsigned long idx, std::string &parameter) const
bool getInstitutionAddress (DCMTree::TreePtr item, std::string &parameter) const
std::string getInstitutionAddressTag () const
bool setInstitutionAddress (unsigned long idx, std::string parameter)
bool getInstitutionName (unsigned long idx, std::string &parameter) const
bool getInstitutionName (DCMTree::TreePtr item, std::string &parameter) const
std::string getInstitutionNameTag () const
bool setInstitutionName (unsigned long idx, std::string parameter)
bool getInstitutionalDepartmentName (unsigned long idx, std::string &parameter) const
bool getInstitutionalDepartmentName (DCMTree::TreePtr item, std::string &parameter) const
std::string getInstitutionalDepartmentNameTag () const
bool setInstitutionalDepartmentName (unsigned long idx, std::string parameter)
bool getManufacturer (unsigned long idx, std::string &parameter) const
bool getManufacturer (DCMTree::TreePtr item, std::string &parameter) const
std::string getManufacturerTag () const
bool setManufacturer (unsigned long idx, std::string parameter)
bool getManufacturerModelName (unsigned long idx, std::string &parameter) const
bool getManufacturerModelName (DCMTree::TreePtr item, std::string &parameter) const
std::string getManufacturerModelNameTag () const
bool setManufacturerModelName (unsigned long idx, std::string parameter)
bool getNumberOfBlocks (unsigned long idx, std::string &parameter) const
bool getNumberOfBlocks (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfBlocksTag () const
bool setNumberOfBlocks (unsigned long idx, std::string parameter)
bool getNumberOfBoli (unsigned long idx, std::string &parameter) const
bool getNumberOfBoli (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfBoliTag () const
bool setNumberOfBoli (unsigned long idx, std::string parameter)
bool getNumberOfCompensators (unsigned long idx, std::string &parameter) const
bool getNumberOfCompensators (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfCompensatorsTag () const
bool setNumberOfCompensators (unsigned long idx, std::string parameter)
bool getNumberOfControlPoints (unsigned long idx, std::string &parameter) const
bool getNumberOfControlPoints (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfControlPointsTag () const
bool setNumberOfControlPoints (unsigned long idx, std::string parameter)
bool getNumberOfWedges (unsigned long idx, std::string &parameter) const
bool getNumberOfWedges (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfWedgesTag () const
bool setNumberOfWedges (unsigned long idx, std::string parameter)
bool getPrimaryDosimeterUnit (unsigned long idx, std::string &parameter) const
bool getPrimaryDosimeterUnit (DCMTree::TreePtr item, std::string &parameter) const
std::string getPrimaryDosimeterUnitTag () const
bool setPrimaryDosimeterUnit (unsigned long idx, std::string parameter)
bool getRadiationType (unsigned long idx, std::string &parameter) const
bool getRadiationType (DCMTree::TreePtr item, std::string &parameter) const
std::string getRadiationTypeTag () const
bool setRadiationType (unsigned long idx, std::string parameter)
bool getReferencedPatientSetupNumber (unsigned long idx, std::string &parameter) const
bool getReferencedPatientSetupNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getReferencedPatientSetupNumberTag () const
bool setReferencedPatientSetupNumber (unsigned long idx, std::string parameter)
bool getReferencedToleranceTableNumber (unsigned long idx, std::string &parameter) const
bool getReferencedToleranceTableNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getReferencedToleranceTableNumberTag () const
bool setReferencedToleranceTableNumber (unsigned long idx, std::string parameter)
bool getSourceAxisDistance (unsigned long idx, std::string &parameter) const
bool getSourceAxisDistance (DCMTree::TreePtr item, std::string &parameter) const
std::string getSourceAxisDistanceTag () const
bool setSourceAxisDistance (unsigned long idx, std::string parameter)
bool getTotalBlockTrayFactor (unsigned long idx, std::string &parameter) const
bool getTotalBlockTrayFactor (DCMTree::TreePtr item, std::string &parameter) const
std::string getTotalBlockTrayFactorTag () const
bool setTotalBlockTrayFactor (unsigned long idx, std::string parameter)
bool getTotalCompensatorTrayFactor (unsigned long idx, std::string &parameter) const
bool getTotalCompensatorTrayFactor (DCMTree::TreePtr item, std::string &parameter) const
std::string getTotalCompensatorTrayFactorTag () const
bool setTotalCompensatorTrayFactor (unsigned long idx, std::string parameter)
bool getTreatmentDeliveryType (unsigned long idx, std::string &parameter) const
bool getTreatmentDeliveryType (DCMTree::TreePtr item, std::string &parameter) const
std::string getTreatmentDeliveryTypeTag () const
bool setTreatmentDeliveryType (unsigned long idx, std::string parameter)
bool getTreatmentMachineName (unsigned long idx, std::string &parameter) const
bool getTreatmentMachineName (DCMTree::TreePtr item, std::string &parameter) const
std::string getTreatmentMachineNameTag () const
bool setTreatmentMachineName (unsigned long idx, std::string parameter)
DcmDRTApplicatorSequenceInRTBeamsModuleInterface getApplicatorSequence (unsigned long idx) const
std::string getApplicatorSequenceTag () const
void setApplicatorSequence (DcmDRTApplicatorSequenceInRTBeamsModuleInterface seq, unsigned long idx)
DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface getBeamLimitingDeviceSequence (unsigned long idx) const
std::string getBeamLimitingDeviceSequenceTag () const
void setBeamLimitingDeviceSequence (DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface seq, unsigned long idx)
DcmDRTBlockSequenceInRTBeamsModuleInterface getBlockSequence (unsigned long idx) const
std::string getBlockSequenceTag () const
void setBlockSequence (DcmDRTBlockSequenceInRTBeamsModuleInterface seq, unsigned long idx)
DcmDRTCompensatorSequenceInterface getCompensatorSequence (unsigned long idx) const
std::string getCompensatorSequenceTag () const
void setCompensatorSequence (DcmDRTCompensatorSequenceInterface seq, unsigned long idx)
DcmDRTControlPointSequenceInterface getControlPointSequence (unsigned long idx) const
std::string getControlPointSequenceTag () const
void setControlPointSequence (DcmDRTControlPointSequenceInterface seq, unsigned long idx)
DcmDRTPlannedVerificationImageSequenceInterface getPlannedVerificationImageSequence (unsigned long idx) const
std::string getPlannedVerificationImageSequenceTag () const
void setPlannedVerificationImageSequence (DcmDRTPlannedVerificationImageSequenceInterface seq, unsigned long idx)
DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface getReferencedBolusSequence (unsigned long idx) const
std::string getReferencedBolusSequenceTag () const
void setReferencedBolusSequence (DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface seq, unsigned long idx)
DcmDRTReferencedDoseSequenceInterface getReferencedDoseSequence (unsigned long idx) const
std::string getReferencedDoseSequenceTag () const
void setReferencedDoseSequence (DcmDRTReferencedDoseSequenceInterface seq, unsigned long idx)
DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface getReferencedReferenceImageSequence (unsigned long idx) const
std::string getReferencedReferenceImageSequenceTag () const
void setReferencedReferenceImageSequence (DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface seq, unsigned long idx)
DcmDRTWedgeSequenceInterface getWedgeSequence (unsigned long idx) const
std::string getWedgeSequenceTag () const
void setWedgeSequence (DcmDRTWedgeSequenceInterface seq, unsigned long idx)
void setSequence (std::vector< DcmDRTBeamSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTBeamSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTBeamSequenceInterface::Item getItem (const size_t idx) const
DcmDRTBeamSequenceInterface::Item & addItem ()
void addItem (DcmDRTBeamSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTBeamSequence.

Definition at line 53 of file mlDcmDRTBeamSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTBeamSequenceInterface() [1/3]

ml::DcmDRTBeamSequenceInterface::DcmDRTBeamSequenceInterface ( )
inline

Definition at line 263 of file mlDcmDRTBeamSequenceInterface.h.

◆ DcmDRTBeamSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 266 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

◆ DcmDRTBeamSequenceInterface() [3/3]

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

Definition at line 268 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTBeamSequenceInterface()

virtual ml::DcmDRTBeamSequenceInterface::~DcmDRTBeamSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 276 of file mlDcmDRTBeamSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 519 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 524 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

◆ getApplicatorSequence()

DcmDRTApplicatorSequenceInRTBeamsModuleInterface ml::DcmDRTBeamSequenceInterface::getApplicatorSequence ( unsigned long idx) const

◆ getApplicatorSequenceTag()

std::string ml::DcmDRTBeamSequenceInterface::getApplicatorSequenceTag ( ) const
inline

Definition at line 435 of file mlDcmDRTBeamSequenceInterface.h.

◆ getBeamDescription() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getBeamDescription ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBeamDescription() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getBeamDescription ( unsigned long idx,
std::string & parameter ) const

◆ getBeamDescriptionTag()

std::string ml::DcmDRTBeamSequenceInterface::getBeamDescriptionTag ( ) const
inline

Definition at line 280 of file mlDcmDRTBeamSequenceInterface.h.

◆ getBeamLimitingDeviceSequence()

DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface ml::DcmDRTBeamSequenceInterface::getBeamLimitingDeviceSequence ( unsigned long idx) const

◆ getBeamLimitingDeviceSequenceTag()

std::string ml::DcmDRTBeamSequenceInterface::getBeamLimitingDeviceSequenceTag ( ) const
inline

Definition at line 440 of file mlDcmDRTBeamSequenceInterface.h.

◆ getBeamName() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getBeamName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBeamName() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getBeamName ( unsigned long idx,
std::string & parameter ) const

◆ getBeamNameTag()

std::string ml::DcmDRTBeamSequenceInterface::getBeamNameTag ( ) const
inline

Definition at line 286 of file mlDcmDRTBeamSequenceInterface.h.

◆ getBeamNumber() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getBeamNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBeamNumber() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getBeamNumber ( unsigned long idx,
std::string & parameter ) const

◆ getBeamNumberTag()

std::string ml::DcmDRTBeamSequenceInterface::getBeamNumberTag ( ) const
inline

Definition at line 292 of file mlDcmDRTBeamSequenceInterface.h.

◆ getBeamType() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getBeamType ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBeamType() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getBeamType ( unsigned long idx,
std::string & parameter ) const

◆ getBeamTypeTag()

std::string ml::DcmDRTBeamSequenceInterface::getBeamTypeTag ( ) const
inline

Definition at line 298 of file mlDcmDRTBeamSequenceInterface.h.

◆ getBlockSequence()

DcmDRTBlockSequenceInRTBeamsModuleInterface ml::DcmDRTBeamSequenceInterface::getBlockSequence ( unsigned long idx) const

◆ getBlockSequenceTag()

std::string ml::DcmDRTBeamSequenceInterface::getBlockSequenceTag ( ) const
inline

Definition at line 445 of file mlDcmDRTBeamSequenceInterface.h.

◆ getCompensatorSequence()

DcmDRTCompensatorSequenceInterface ml::DcmDRTBeamSequenceInterface::getCompensatorSequence ( unsigned long idx) const

◆ getCompensatorSequenceTag()

std::string ml::DcmDRTBeamSequenceInterface::getCompensatorSequenceTag ( ) const
inline

Definition at line 450 of file mlDcmDRTBeamSequenceInterface.h.

◆ getControlPointSequence()

DcmDRTControlPointSequenceInterface ml::DcmDRTBeamSequenceInterface::getControlPointSequence ( unsigned long idx) const

◆ getControlPointSequenceTag()

std::string ml::DcmDRTBeamSequenceInterface::getControlPointSequenceTag ( ) const
inline

Definition at line 455 of file mlDcmDRTBeamSequenceInterface.h.

◆ getDeviceSerialNumber() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getDeviceSerialNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getDeviceSerialNumber() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getDeviceSerialNumber ( unsigned long idx,
std::string & parameter ) const

◆ getDeviceSerialNumberTag()

std::string ml::DcmDRTBeamSequenceInterface::getDeviceSerialNumberTag ( ) const
inline

Definition at line 304 of file mlDcmDRTBeamSequenceInterface.h.

◆ getFinalCumulativeMetersetWeight() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getFinalCumulativeMetersetWeight ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getFinalCumulativeMetersetWeight() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getFinalCumulativeMetersetWeight ( unsigned long idx,
std::string & parameter ) const

◆ getFinalCumulativeMetersetWeightTag()

std::string ml::DcmDRTBeamSequenceInterface::getFinalCumulativeMetersetWeightTag ( ) const
inline

Definition at line 310 of file mlDcmDRTBeamSequenceInterface.h.

◆ getHighDoseTechniqueType() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getHighDoseTechniqueType ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getHighDoseTechniqueType() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getHighDoseTechniqueType ( unsigned long idx,
std::string & parameter ) const

◆ getHighDoseTechniqueTypeTag()

std::string ml::DcmDRTBeamSequenceInterface::getHighDoseTechniqueTypeTag ( ) const
inline

Definition at line 316 of file mlDcmDRTBeamSequenceInterface.h.

◆ getInstitutionAddress() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getInstitutionAddress ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getInstitutionAddress() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getInstitutionAddress ( unsigned long idx,
std::string & parameter ) const

◆ getInstitutionAddressTag()

std::string ml::DcmDRTBeamSequenceInterface::getInstitutionAddressTag ( ) const
inline

Definition at line 322 of file mlDcmDRTBeamSequenceInterface.h.

◆ getInstitutionalDepartmentName() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getInstitutionalDepartmentName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getInstitutionalDepartmentName() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getInstitutionalDepartmentName ( unsigned long idx,
std::string & parameter ) const

◆ getInstitutionalDepartmentNameTag()

std::string ml::DcmDRTBeamSequenceInterface::getInstitutionalDepartmentNameTag ( ) const
inline

Definition at line 334 of file mlDcmDRTBeamSequenceInterface.h.

◆ getInstitutionName() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getInstitutionName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getInstitutionName() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getInstitutionName ( unsigned long idx,
std::string & parameter ) const

◆ getInstitutionNameTag()

std::string ml::DcmDRTBeamSequenceInterface::getInstitutionNameTag ( ) const
inline

Definition at line 328 of file mlDcmDRTBeamSequenceInterface.h.

◆ getItem()

DcmDRTBeamSequenceInterface::Item ml::DcmDRTBeamSequenceInterface::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 510 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

◆ getManufacturer() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getManufacturer ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getManufacturer() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getManufacturer ( unsigned long idx,
std::string & parameter ) const

◆ getManufacturerModelName() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getManufacturerModelName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getManufacturerModelName() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getManufacturerModelName ( unsigned long idx,
std::string & parameter ) const

◆ getManufacturerModelNameTag()

std::string ml::DcmDRTBeamSequenceInterface::getManufacturerModelNameTag ( ) const
inline

Definition at line 346 of file mlDcmDRTBeamSequenceInterface.h.

◆ getManufacturerTag()

std::string ml::DcmDRTBeamSequenceInterface::getManufacturerTag ( ) const
inline

Definition at line 340 of file mlDcmDRTBeamSequenceInterface.h.

◆ getNumberOfBlocks() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getNumberOfBlocks ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfBlocks() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getNumberOfBlocks ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfBlocksTag()

std::string ml::DcmDRTBeamSequenceInterface::getNumberOfBlocksTag ( ) const
inline

Definition at line 352 of file mlDcmDRTBeamSequenceInterface.h.

◆ getNumberOfBoli() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getNumberOfBoli ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfBoli() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getNumberOfBoli ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfBoliTag()

std::string ml::DcmDRTBeamSequenceInterface::getNumberOfBoliTag ( ) const
inline

Definition at line 358 of file mlDcmDRTBeamSequenceInterface.h.

◆ getNumberOfCompensators() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getNumberOfCompensators ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfCompensators() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getNumberOfCompensators ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfCompensatorsTag()

std::string ml::DcmDRTBeamSequenceInterface::getNumberOfCompensatorsTag ( ) const
inline

Definition at line 364 of file mlDcmDRTBeamSequenceInterface.h.

◆ getNumberOfControlPoints() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getNumberOfControlPoints ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfControlPoints() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getNumberOfControlPoints ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfControlPointsTag()

std::string ml::DcmDRTBeamSequenceInterface::getNumberOfControlPointsTag ( ) const
inline

Definition at line 370 of file mlDcmDRTBeamSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTBeamSequenceInterface::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 504 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

◆ getNumberOfWedges() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getNumberOfWedges ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfWedges() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getNumberOfWedges ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfWedgesTag()

std::string ml::DcmDRTBeamSequenceInterface::getNumberOfWedgesTag ( ) const
inline

Definition at line 376 of file mlDcmDRTBeamSequenceInterface.h.

◆ getPlannedVerificationImageSequence()

DcmDRTPlannedVerificationImageSequenceInterface ml::DcmDRTBeamSequenceInterface::getPlannedVerificationImageSequence ( unsigned long idx) const

◆ getPlannedVerificationImageSequenceTag()

std::string ml::DcmDRTBeamSequenceInterface::getPlannedVerificationImageSequenceTag ( ) const
inline

Definition at line 460 of file mlDcmDRTBeamSequenceInterface.h.

◆ getPrimaryDosimeterUnit() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getPrimaryDosimeterUnit ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getPrimaryDosimeterUnit() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getPrimaryDosimeterUnit ( unsigned long idx,
std::string & parameter ) const

◆ getPrimaryDosimeterUnitTag()

std::string ml::DcmDRTBeamSequenceInterface::getPrimaryDosimeterUnitTag ( ) const
inline

Definition at line 382 of file mlDcmDRTBeamSequenceInterface.h.

◆ getRadiationType() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getRadiationType ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getRadiationType() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getRadiationType ( unsigned long idx,
std::string & parameter ) const

◆ getRadiationTypeTag()

std::string ml::DcmDRTBeamSequenceInterface::getRadiationTypeTag ( ) const
inline

Definition at line 388 of file mlDcmDRTBeamSequenceInterface.h.

◆ getReferencedBolusSequence()

DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ml::DcmDRTBeamSequenceInterface::getReferencedBolusSequence ( unsigned long idx) const

◆ getReferencedBolusSequenceTag()

std::string ml::DcmDRTBeamSequenceInterface::getReferencedBolusSequenceTag ( ) const
inline

Definition at line 465 of file mlDcmDRTBeamSequenceInterface.h.

◆ getReferencedDoseSequence()

DcmDRTReferencedDoseSequenceInterface ml::DcmDRTBeamSequenceInterface::getReferencedDoseSequence ( unsigned long idx) const

◆ getReferencedDoseSequenceTag()

std::string ml::DcmDRTBeamSequenceInterface::getReferencedDoseSequenceTag ( ) const
inline

Definition at line 470 of file mlDcmDRTBeamSequenceInterface.h.

◆ getReferencedPatientSetupNumber() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getReferencedPatientSetupNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReferencedPatientSetupNumber() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getReferencedPatientSetupNumber ( unsigned long idx,
std::string & parameter ) const

◆ getReferencedPatientSetupNumberTag()

std::string ml::DcmDRTBeamSequenceInterface::getReferencedPatientSetupNumberTag ( ) const
inline

Definition at line 394 of file mlDcmDRTBeamSequenceInterface.h.

◆ getReferencedReferenceImageSequence()

DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface ml::DcmDRTBeamSequenceInterface::getReferencedReferenceImageSequence ( unsigned long idx) const

◆ getReferencedReferenceImageSequenceTag()

std::string ml::DcmDRTBeamSequenceInterface::getReferencedReferenceImageSequenceTag ( ) const
inline

Definition at line 475 of file mlDcmDRTBeamSequenceInterface.h.

◆ getReferencedToleranceTableNumber() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getReferencedToleranceTableNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReferencedToleranceTableNumber() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getReferencedToleranceTableNumber ( unsigned long idx,
std::string & parameter ) const

◆ getReferencedToleranceTableNumberTag()

std::string ml::DcmDRTBeamSequenceInterface::getReferencedToleranceTableNumberTag ( ) const
inline

Definition at line 400 of file mlDcmDRTBeamSequenceInterface.h.

◆ getSequence()

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

Return the DRTBeamSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTBeamSequence

Definition at line 492 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

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

◆ getSourceAxisDistance() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getSourceAxisDistance ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getSourceAxisDistance() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getSourceAxisDistance ( unsigned long idx,
std::string & parameter ) const

◆ getSourceAxisDistanceTag()

std::string ml::DcmDRTBeamSequenceInterface::getSourceAxisDistanceTag ( ) const
inline

Definition at line 406 of file mlDcmDRTBeamSequenceInterface.h.

◆ getTotalBlockTrayFactor() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getTotalBlockTrayFactor ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTotalBlockTrayFactor() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getTotalBlockTrayFactor ( unsigned long idx,
std::string & parameter ) const

◆ getTotalBlockTrayFactorTag()

std::string ml::DcmDRTBeamSequenceInterface::getTotalBlockTrayFactorTag ( ) const
inline

Definition at line 412 of file mlDcmDRTBeamSequenceInterface.h.

◆ getTotalCompensatorTrayFactor() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getTotalCompensatorTrayFactor ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTotalCompensatorTrayFactor() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getTotalCompensatorTrayFactor ( unsigned long idx,
std::string & parameter ) const

◆ getTotalCompensatorTrayFactorTag()

std::string ml::DcmDRTBeamSequenceInterface::getTotalCompensatorTrayFactorTag ( ) const
inline

Definition at line 418 of file mlDcmDRTBeamSequenceInterface.h.

◆ getTreatmentDeliveryType() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getTreatmentDeliveryType ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTreatmentDeliveryType() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getTreatmentDeliveryType ( unsigned long idx,
std::string & parameter ) const

◆ getTreatmentDeliveryTypeTag()

std::string ml::DcmDRTBeamSequenceInterface::getTreatmentDeliveryTypeTag ( ) const
inline

Definition at line 424 of file mlDcmDRTBeamSequenceInterface.h.

◆ getTreatmentMachineName() [1/2]

bool ml::DcmDRTBeamSequenceInterface::getTreatmentMachineName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTreatmentMachineName() [2/2]

bool ml::DcmDRTBeamSequenceInterface::getTreatmentMachineName ( unsigned long idx,
std::string & parameter ) const

◆ getTreatmentMachineNameTag()

std::string ml::DcmDRTBeamSequenceInterface::getTreatmentMachineNameTag ( ) const
inline

Definition at line 430 of file mlDcmDRTBeamSequenceInterface.h.

◆ getWedgeSequence()

DcmDRTWedgeSequenceInterface ml::DcmDRTBeamSequenceInterface::getWedgeSequence ( unsigned long idx) const

◆ getWedgeSequenceTag()

std::string ml::DcmDRTBeamSequenceInterface::getWedgeSequenceTag ( ) const
inline

Definition at line 480 of file mlDcmDRTBeamSequenceInterface.h.

◆ hasSequence()

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

Check if the DRTBeamSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 498 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTBeamSequenceInterface::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 530 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTBeamSequenceInterface::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 542 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

◆ setApplicatorSequence()

void ml::DcmDRTBeamSequenceInterface::setApplicatorSequence ( DcmDRTApplicatorSequenceInRTBeamsModuleInterface seq,
unsigned long idx )

◆ setBeamDescription()

bool ml::DcmDRTBeamSequenceInterface::setBeamDescription ( unsigned long idx,
std::string parameter )

◆ setBeamLimitingDeviceSequence()

void ml::DcmDRTBeamSequenceInterface::setBeamLimitingDeviceSequence ( DcmDRTBeamLimitingDeviceSequenceInRTBeamsModuleInterface seq,
unsigned long idx )

◆ setBeamName()

bool ml::DcmDRTBeamSequenceInterface::setBeamName ( unsigned long idx,
std::string parameter )

◆ setBeamNumber()

bool ml::DcmDRTBeamSequenceInterface::setBeamNumber ( unsigned long idx,
std::string parameter )

◆ setBeamType()

bool ml::DcmDRTBeamSequenceInterface::setBeamType ( unsigned long idx,
std::string parameter )

◆ setBlockSequence()

void ml::DcmDRTBeamSequenceInterface::setBlockSequence ( DcmDRTBlockSequenceInRTBeamsModuleInterface seq,
unsigned long idx )

◆ setCompensatorSequence()

void ml::DcmDRTBeamSequenceInterface::setCompensatorSequence ( DcmDRTCompensatorSequenceInterface seq,
unsigned long idx )

◆ setControlPointSequence()

void ml::DcmDRTBeamSequenceInterface::setControlPointSequence ( DcmDRTControlPointSequenceInterface seq,
unsigned long idx )

◆ setDeviceSerialNumber()

bool ml::DcmDRTBeamSequenceInterface::setDeviceSerialNumber ( unsigned long idx,
std::string parameter )

◆ setFinalCumulativeMetersetWeight()

bool ml::DcmDRTBeamSequenceInterface::setFinalCumulativeMetersetWeight ( unsigned long idx,
std::string parameter )

◆ setHighDoseTechniqueType()

bool ml::DcmDRTBeamSequenceInterface::setHighDoseTechniqueType ( unsigned long idx,
std::string parameter )

◆ setInstitutionAddress()

bool ml::DcmDRTBeamSequenceInterface::setInstitutionAddress ( unsigned long idx,
std::string parameter )

◆ setInstitutionalDepartmentName()

bool ml::DcmDRTBeamSequenceInterface::setInstitutionalDepartmentName ( unsigned long idx,
std::string parameter )

◆ setInstitutionName()

bool ml::DcmDRTBeamSequenceInterface::setInstitutionName ( unsigned long idx,
std::string parameter )

◆ setManufacturer()

bool ml::DcmDRTBeamSequenceInterface::setManufacturer ( unsigned long idx,
std::string parameter )

◆ setManufacturerModelName()

bool ml::DcmDRTBeamSequenceInterface::setManufacturerModelName ( unsigned long idx,
std::string parameter )

◆ setNumberOfBlocks()

bool ml::DcmDRTBeamSequenceInterface::setNumberOfBlocks ( unsigned long idx,
std::string parameter )

◆ setNumberOfBoli()

bool ml::DcmDRTBeamSequenceInterface::setNumberOfBoli ( unsigned long idx,
std::string parameter )

◆ setNumberOfCompensators()

bool ml::DcmDRTBeamSequenceInterface::setNumberOfCompensators ( unsigned long idx,
std::string parameter )

◆ setNumberOfControlPoints()

bool ml::DcmDRTBeamSequenceInterface::setNumberOfControlPoints ( unsigned long idx,
std::string parameter )

◆ setNumberOfWedges()

bool ml::DcmDRTBeamSequenceInterface::setNumberOfWedges ( unsigned long idx,
std::string parameter )

◆ setPlannedVerificationImageSequence()

void ml::DcmDRTBeamSequenceInterface::setPlannedVerificationImageSequence ( DcmDRTPlannedVerificationImageSequenceInterface seq,
unsigned long idx )

◆ setPrimaryDosimeterUnit()

bool ml::DcmDRTBeamSequenceInterface::setPrimaryDosimeterUnit ( unsigned long idx,
std::string parameter )

◆ setRadiationType()

bool ml::DcmDRTBeamSequenceInterface::setRadiationType ( unsigned long idx,
std::string parameter )

◆ setReferencedBolusSequence()

void ml::DcmDRTBeamSequenceInterface::setReferencedBolusSequence ( DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface seq,
unsigned long idx )

◆ setReferencedDoseSequence()

void ml::DcmDRTBeamSequenceInterface::setReferencedDoseSequence ( DcmDRTReferencedDoseSequenceInterface seq,
unsigned long idx )

◆ setReferencedPatientSetupNumber()

bool ml::DcmDRTBeamSequenceInterface::setReferencedPatientSetupNumber ( unsigned long idx,
std::string parameter )

◆ setReferencedReferenceImageSequence()

void ml::DcmDRTBeamSequenceInterface::setReferencedReferenceImageSequence ( DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface seq,
unsigned long idx )

◆ setReferencedToleranceTableNumber()

bool ml::DcmDRTBeamSequenceInterface::setReferencedToleranceTableNumber ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTBeamSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTBeamSequence

Definition at line 486 of file mlDcmDRTBeamSequenceInterface.h.

References _itemVec.

◆ setSourceAxisDistance()

bool ml::DcmDRTBeamSequenceInterface::setSourceAxisDistance ( unsigned long idx,
std::string parameter )

◆ setTotalBlockTrayFactor()

bool ml::DcmDRTBeamSequenceInterface::setTotalBlockTrayFactor ( unsigned long idx,
std::string parameter )

◆ setTotalCompensatorTrayFactor()

bool ml::DcmDRTBeamSequenceInterface::setTotalCompensatorTrayFactor ( unsigned long idx,
std::string parameter )

◆ setTreatmentDeliveryType()

bool ml::DcmDRTBeamSequenceInterface::setTreatmentDeliveryType ( unsigned long idx,
std::string parameter )

◆ setTreatmentMachineName()

bool ml::DcmDRTBeamSequenceInterface::setTreatmentMachineName ( unsigned long idx,
std::string parameter )

◆ setWedgeSequence()

void ml::DcmDRTBeamSequenceInterface::setWedgeSequence ( DcmDRTWedgeSequenceInterface seq,
unsigned long idx )

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 554 of file mlDcmDRTBeamSequenceInterface.h.

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

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