MeVisLab Toolbox Reference
ml::DcmDRTIonControlPointSequenceInterface Class Reference

Class to provide access to DRTIonControlPointSequence. More...

#include <mlDcmDRTIonControlPointSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTIonControlPointSequenceInterface ()
 DcmDRTIonControlPointSequenceInterface (std::vector< DcmDRTIonControlPointSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTIonControlPointSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTIonControlPointSequenceInterface ()
 Default virtual Destructor.
bool getBeamLimitingDeviceAngle (unsigned long idx, std::string &parameter) const
bool getBeamLimitingDeviceAngle (DCMTree::TreePtr item, std::string &parameter) const
std::string getBeamLimitingDeviceAngleTag () const
bool setBeamLimitingDeviceAngle (unsigned long idx, std::string parameter)
bool getBeamLimitingDeviceRotationDirection (unsigned long idx, std::string &parameter) const
bool getBeamLimitingDeviceRotationDirection (DCMTree::TreePtr item, std::string &parameter) const
std::string getBeamLimitingDeviceRotationDirectionTag () const
bool setBeamLimitingDeviceRotationDirection (unsigned long idx, std::string parameter)
bool getControlPointIndex (unsigned long idx, std::string &parameter) const
bool getControlPointIndex (DCMTree::TreePtr item, std::string &parameter) const
std::string getControlPointIndexTag () const
bool setControlPointIndex (unsigned long idx, std::string parameter)
bool getCumulativeMetersetWeight (unsigned long idx, std::string &parameter) const
bool getCumulativeMetersetWeight (DCMTree::TreePtr item, std::string &parameter) const
std::string getCumulativeMetersetWeightTag () const
bool setCumulativeMetersetWeight (unsigned long idx, std::string parameter)
bool getGantryAngle (unsigned long idx, std::string &parameter) const
bool getGantryAngle (DCMTree::TreePtr item, std::string &parameter) const
std::string getGantryAngleTag () const
bool setGantryAngle (unsigned long idx, std::string parameter)
bool getGantryPitchAngle (unsigned long idx, float &parameter) const
bool getGantryPitchAngle (DCMTree::TreePtr item, float &parameter) const
std::string getGantryPitchAngleTag () const
bool setGantryPitchAngle (unsigned long idx, float parameter)
bool getGantryPitchRotationDirection (unsigned long idx, std::string &parameter) const
bool getGantryPitchRotationDirection (DCMTree::TreePtr item, std::string &parameter) const
std::string getGantryPitchRotationDirectionTag () const
bool setGantryPitchRotationDirection (unsigned long idx, std::string parameter)
bool getGantryRotationDirection (unsigned long idx, std::string &parameter) const
bool getGantryRotationDirection (DCMTree::TreePtr item, std::string &parameter) const
std::string getGantryRotationDirectionTag () const
bool setGantryRotationDirection (unsigned long idx, std::string parameter)
bool getHeadFixationAngle (unsigned long idx, float &parameter) const
bool getHeadFixationAngle (DCMTree::TreePtr item, float &parameter) const
std::string getHeadFixationAngleTag () const
bool setHeadFixationAngle (unsigned long idx, float parameter)
bool getIsocenterPosition (unsigned long idx, std::string &parameter) const
bool getIsocenterPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string getIsocenterPositionTag () const
bool setIsocenterPosition (unsigned long idx, std::string parameter)
bool getKVP (unsigned long idx, std::string &parameter) const
bool getKVP (DCMTree::TreePtr item, std::string &parameter) const
std::string getKVPTag () const
bool setKVP (unsigned long idx, std::string parameter)
bool getMetersetRate (unsigned long idx, float &parameter) const
bool getMetersetRate (DCMTree::TreePtr item, float &parameter) const
std::string getMetersetRateTag () const
bool setMetersetRate (unsigned long idx, float parameter)
bool getNominalBeamEnergy (unsigned long idx, std::string &parameter) const
bool getNominalBeamEnergy (DCMTree::TreePtr item, std::string &parameter) const
std::string getNominalBeamEnergyTag () const
bool setNominalBeamEnergy (unsigned long idx, std::string parameter)
bool getNumberOfPaintings (unsigned long idx, std::string &parameter) const
bool getNumberOfPaintings (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfPaintingsTag () const
bool setNumberOfPaintings (unsigned long idx, std::string parameter)
bool getNumberOfScanSpotPositions (unsigned long idx, std::string &parameter) const
bool getNumberOfScanSpotPositions (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfScanSpotPositionsTag () const
bool setNumberOfScanSpotPositions (unsigned long idx, std::string parameter)
bool getPatientSupportAngle (unsigned long idx, std::string &parameter) const
bool getPatientSupportAngle (DCMTree::TreePtr item, std::string &parameter) const
std::string getPatientSupportAngleTag () const
bool setPatientSupportAngle (unsigned long idx, std::string parameter)
bool getPatientSupportRotationDirection (unsigned long idx, std::string &parameter) const
bool getPatientSupportRotationDirection (DCMTree::TreePtr item, std::string &parameter) const
std::string getPatientSupportRotationDirectionTag () const
bool setPatientSupportRotationDirection (unsigned long idx, std::string parameter)
bool getScanSpotMetersetWeights (unsigned long idx, float &parameter) const
bool getScanSpotMetersetWeights (DCMTree::TreePtr item, float &parameter) const
std::string getScanSpotMetersetWeightsTag () const
bool setScanSpotMetersetWeights (unsigned long idx, float parameter)
bool getScanSpotPositionMap (unsigned long idx, float &parameter) const
bool getScanSpotPositionMap (DCMTree::TreePtr item, float &parameter) const
std::string getScanSpotPositionMapTag () const
bool setScanSpotPositionMap (unsigned long idx, float parameter)
bool getScanSpotTuneID (unsigned long idx, std::string &parameter) const
bool getScanSpotTuneID (DCMTree::TreePtr item, std::string &parameter) const
std::string getScanSpotTuneIDTag () const
bool setScanSpotTuneID (unsigned long idx, std::string parameter)
bool getScanningSpotSize (unsigned long idx, float &parameter) const
bool getScanningSpotSize (DCMTree::TreePtr item, float &parameter) const
std::string getScanningSpotSizeTag () const
bool setScanningSpotSize (unsigned long idx, float parameter)
bool getSnoutPosition (unsigned long idx, float &parameter) const
bool getSnoutPosition (DCMTree::TreePtr item, float &parameter) const
std::string getSnoutPositionTag () const
bool setSnoutPosition (unsigned long idx, float parameter)
bool getSurfaceEntryPoint (unsigned long idx, std::string &parameter) const
bool getSurfaceEntryPoint (DCMTree::TreePtr item, std::string &parameter) const
std::string getSurfaceEntryPointTag () const
bool setSurfaceEntryPoint (unsigned long idx, std::string parameter)
bool getTableTopLateralPosition (unsigned long idx, std::string &parameter) const
bool getTableTopLateralPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string getTableTopLateralPositionTag () const
bool setTableTopLateralPosition (unsigned long idx, std::string parameter)
bool getTableTopLongitudinalPosition (unsigned long idx, std::string &parameter) const
bool getTableTopLongitudinalPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string getTableTopLongitudinalPositionTag () const
bool setTableTopLongitudinalPosition (unsigned long idx, std::string parameter)
bool getTableTopPitchAngle (unsigned long idx, float &parameter) const
bool getTableTopPitchAngle (DCMTree::TreePtr item, float &parameter) const
std::string getTableTopPitchAngleTag () const
bool setTableTopPitchAngle (unsigned long idx, float parameter)
bool getTableTopPitchRotationDirection (unsigned long idx, std::string &parameter) const
bool getTableTopPitchRotationDirection (DCMTree::TreePtr item, std::string &parameter) const
std::string getTableTopPitchRotationDirectionTag () const
bool setTableTopPitchRotationDirection (unsigned long idx, std::string parameter)
bool getTableTopRollAngle (unsigned long idx, float &parameter) const
bool getTableTopRollAngle (DCMTree::TreePtr item, float &parameter) const
std::string getTableTopRollAngleTag () const
bool setTableTopRollAngle (unsigned long idx, float parameter)
bool getTableTopRollRotationDirection (unsigned long idx, std::string &parameter) const
bool getTableTopRollRotationDirection (DCMTree::TreePtr item, std::string &parameter) const
std::string getTableTopRollRotationDirectionTag () const
bool setTableTopRollRotationDirection (unsigned long idx, std::string parameter)
bool getTableTopVerticalPosition (unsigned long idx, std::string &parameter) const
bool getTableTopVerticalPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string getTableTopVerticalPositionTag () const
bool setTableTopVerticalPosition (unsigned long idx, std::string parameter)
DcmDRTBeamLimitingDevicePositionSequenceInterface getBeamLimitingDevicePositionSequence (unsigned long idx) const
std::string getBeamLimitingDevicePositionSequenceTag () const
void setBeamLimitingDevicePositionSequence (DcmDRTBeamLimitingDevicePositionSequenceInterface seq, unsigned long idx)
DcmDRTIonWedgePositionSequenceInterface getIonWedgePositionSequence (unsigned long idx) const
std::string getIonWedgePositionSequenceTag () const
void setIonWedgePositionSequence (DcmDRTIonWedgePositionSequenceInterface seq, unsigned long idx)
DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface getLateralSpreadingDeviceSettingsSequence (unsigned long idx) const
std::string getLateralSpreadingDeviceSettingsSequenceTag () const
void setLateralSpreadingDeviceSettingsSequence (DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface seq, unsigned long idx)
DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface getRangeModulatorSettingsSequence (unsigned long idx) const
std::string getRangeModulatorSettingsSequenceTag () const
void setRangeModulatorSettingsSequence (DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface seq, unsigned long idx)
DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface getRangeShifterSettingsSequence (unsigned long idx) const
std::string getRangeShifterSettingsSequenceTag () const
void setRangeShifterSettingsSequence (DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface seq, unsigned long idx)
DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface getReferencedDoseReferenceSequence (unsigned long idx) const
std::string getReferencedDoseReferenceSequenceTag () const
void setReferencedDoseReferenceSequence (DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface seq, unsigned long idx)
void setSequence (std::vector< DcmDRTIonControlPointSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTIonControlPointSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTIonControlPointSequenceInterface::Item getItem (const size_t idx) const
DcmDRTIonControlPointSequenceInterface::Item & addItem ()
void addItem (DcmDRTIonControlPointSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTIonControlPointSequence.

Definition at line 49 of file mlDcmDRTIonControlPointSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTIonControlPointSequenceInterface() [1/3]

ml::DcmDRTIonControlPointSequenceInterface::DcmDRTIonControlPointSequenceInterface ( )
inline

Definition at line 259 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ DcmDRTIonControlPointSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 262 of file mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

◆ DcmDRTIonControlPointSequenceInterface() [3/3]

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

Definition at line 264 of file mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTIonControlPointSequenceInterface()

virtual ml::DcmDRTIonControlPointSequenceInterface::~DcmDRTIonControlPointSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 272 of file mlDcmDRTIonControlPointSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTIonControlPointSequenceInterface::Item & ml::DcmDRTIonControlPointSequenceInterface::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 mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 524 of file mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

◆ getBeamLimitingDeviceAngle() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getBeamLimitingDeviceAngle ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBeamLimitingDeviceAngle() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getBeamLimitingDeviceAngle ( unsigned long idx,
std::string & parameter ) const

◆ getBeamLimitingDeviceAngleTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getBeamLimitingDeviceAngleTag ( ) const
inline

Definition at line 276 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getBeamLimitingDevicePositionSequence()

DcmDRTBeamLimitingDevicePositionSequenceInterface ml::DcmDRTIonControlPointSequenceInterface::getBeamLimitingDevicePositionSequence ( unsigned long idx) const

◆ getBeamLimitingDevicePositionSequenceTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getBeamLimitingDevicePositionSequenceTag ( ) const
inline

Definition at line 455 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getBeamLimitingDeviceRotationDirection() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getBeamLimitingDeviceRotationDirection ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBeamLimitingDeviceRotationDirection() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getBeamLimitingDeviceRotationDirection ( unsigned long idx,
std::string & parameter ) const

◆ getBeamLimitingDeviceRotationDirectionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getBeamLimitingDeviceRotationDirectionTag ( ) const
inline

Definition at line 282 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getControlPointIndex() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getControlPointIndex ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getControlPointIndex() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getControlPointIndex ( unsigned long idx,
std::string & parameter ) const

◆ getControlPointIndexTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getControlPointIndexTag ( ) const
inline

Definition at line 288 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getCumulativeMetersetWeight() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getCumulativeMetersetWeight ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCumulativeMetersetWeight() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getCumulativeMetersetWeight ( unsigned long idx,
std::string & parameter ) const

◆ getCumulativeMetersetWeightTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getCumulativeMetersetWeightTag ( ) const
inline

Definition at line 294 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getGantryAngle() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getGantryAngle ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getGantryAngle() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getGantryAngle ( unsigned long idx,
std::string & parameter ) const

◆ getGantryAngleTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getGantryAngleTag ( ) const
inline

Definition at line 300 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getGantryPitchAngle() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getGantryPitchAngle ( DCMTree::TreePtr item,
float & parameter ) const

◆ getGantryPitchAngle() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getGantryPitchAngle ( unsigned long idx,
float & parameter ) const

◆ getGantryPitchAngleTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getGantryPitchAngleTag ( ) const
inline

Definition at line 306 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getGantryPitchRotationDirection() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getGantryPitchRotationDirection ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getGantryPitchRotationDirection() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getGantryPitchRotationDirection ( unsigned long idx,
std::string & parameter ) const

◆ getGantryPitchRotationDirectionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getGantryPitchRotationDirectionTag ( ) const
inline

Definition at line 312 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getGantryRotationDirection() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getGantryRotationDirection ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getGantryRotationDirection() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getGantryRotationDirection ( unsigned long idx,
std::string & parameter ) const

◆ getGantryRotationDirectionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getGantryRotationDirectionTag ( ) const
inline

Definition at line 318 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getHeadFixationAngle() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getHeadFixationAngle ( DCMTree::TreePtr item,
float & parameter ) const

◆ getHeadFixationAngle() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getHeadFixationAngle ( unsigned long idx,
float & parameter ) const

◆ getHeadFixationAngleTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getHeadFixationAngleTag ( ) const
inline

Definition at line 324 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getIonWedgePositionSequence()

DcmDRTIonWedgePositionSequenceInterface ml::DcmDRTIonControlPointSequenceInterface::getIonWedgePositionSequence ( unsigned long idx) const

◆ getIonWedgePositionSequenceTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getIonWedgePositionSequenceTag ( ) const
inline

Definition at line 460 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getIsocenterPosition() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getIsocenterPosition ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getIsocenterPosition() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getIsocenterPosition ( unsigned long idx,
std::string & parameter ) const

◆ getIsocenterPositionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getIsocenterPositionTag ( ) const
inline

Definition at line 330 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getItem()

DcmDRTIonControlPointSequenceInterface::Item ml::DcmDRTIonControlPointSequenceInterface::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 mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

◆ getKVP() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getKVP ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getKVP() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getKVP ( unsigned long idx,
std::string & parameter ) const

◆ getKVPTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getKVPTag ( ) const
inline

Definition at line 336 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getLateralSpreadingDeviceSettingsSequence()

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface ml::DcmDRTIonControlPointSequenceInterface::getLateralSpreadingDeviceSettingsSequence ( unsigned long idx) const

◆ getLateralSpreadingDeviceSettingsSequenceTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getLateralSpreadingDeviceSettingsSequenceTag ( ) const
inline

Definition at line 465 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getMetersetRate() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getMetersetRate ( DCMTree::TreePtr item,
float & parameter ) const

◆ getMetersetRate() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getMetersetRate ( unsigned long idx,
float & parameter ) const

◆ getMetersetRateTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getMetersetRateTag ( ) const
inline

Definition at line 342 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getNominalBeamEnergy() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getNominalBeamEnergy ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNominalBeamEnergy() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getNominalBeamEnergy ( unsigned long idx,
std::string & parameter ) const

◆ getNominalBeamEnergyTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getNominalBeamEnergyTag ( ) const
inline

Definition at line 348 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTIonControlPointSequenceInterface::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 mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

◆ getNumberOfPaintings() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getNumberOfPaintings ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfPaintings() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getNumberOfPaintings ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfPaintingsTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getNumberOfPaintingsTag ( ) const
inline

Definition at line 354 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getNumberOfScanSpotPositions() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getNumberOfScanSpotPositions ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfScanSpotPositions() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getNumberOfScanSpotPositions ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfScanSpotPositionsTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getNumberOfScanSpotPositionsTag ( ) const
inline

Definition at line 360 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getPatientSupportAngle() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getPatientSupportAngle ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getPatientSupportAngle() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getPatientSupportAngle ( unsigned long idx,
std::string & parameter ) const

◆ getPatientSupportAngleTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getPatientSupportAngleTag ( ) const
inline

Definition at line 366 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getPatientSupportRotationDirection() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getPatientSupportRotationDirection ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getPatientSupportRotationDirection() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getPatientSupportRotationDirection ( unsigned long idx,
std::string & parameter ) const

◆ getPatientSupportRotationDirectionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getPatientSupportRotationDirectionTag ( ) const
inline

Definition at line 372 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getRangeModulatorSettingsSequence()

DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface ml::DcmDRTIonControlPointSequenceInterface::getRangeModulatorSettingsSequence ( unsigned long idx) const

◆ getRangeModulatorSettingsSequenceTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getRangeModulatorSettingsSequenceTag ( ) const
inline

Definition at line 470 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getRangeShifterSettingsSequence()

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface ml::DcmDRTIonControlPointSequenceInterface::getRangeShifterSettingsSequence ( unsigned long idx) const

◆ getRangeShifterSettingsSequenceTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getRangeShifterSettingsSequenceTag ( ) const
inline

Definition at line 475 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getReferencedDoseReferenceSequence()

DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface ml::DcmDRTIonControlPointSequenceInterface::getReferencedDoseReferenceSequence ( unsigned long idx) const

◆ getReferencedDoseReferenceSequenceTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getReferencedDoseReferenceSequenceTag ( ) const
inline

Definition at line 480 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getScanningSpotSize() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getScanningSpotSize ( DCMTree::TreePtr item,
float & parameter ) const

◆ getScanningSpotSize() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getScanningSpotSize ( unsigned long idx,
float & parameter ) const

◆ getScanningSpotSizeTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getScanningSpotSizeTag ( ) const
inline

Definition at line 396 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getScanSpotMetersetWeights() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getScanSpotMetersetWeights ( DCMTree::TreePtr item,
float & parameter ) const

◆ getScanSpotMetersetWeights() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getScanSpotMetersetWeights ( unsigned long idx,
float & parameter ) const

◆ getScanSpotMetersetWeightsTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getScanSpotMetersetWeightsTag ( ) const
inline

Definition at line 378 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getScanSpotPositionMap() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getScanSpotPositionMap ( DCMTree::TreePtr item,
float & parameter ) const

◆ getScanSpotPositionMap() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getScanSpotPositionMap ( unsigned long idx,
float & parameter ) const

◆ getScanSpotPositionMapTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getScanSpotPositionMapTag ( ) const
inline

Definition at line 384 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getScanSpotTuneID() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getScanSpotTuneID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getScanSpotTuneID() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getScanSpotTuneID ( unsigned long idx,
std::string & parameter ) const

◆ getScanSpotTuneIDTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getScanSpotTuneIDTag ( ) const
inline

Definition at line 390 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getSequence()

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

Return the DRTIonControlPointSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIonControlPointSequence

Definition at line 492 of file mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

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

◆ getSnoutPosition() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getSnoutPosition ( DCMTree::TreePtr item,
float & parameter ) const

◆ getSnoutPosition() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getSnoutPosition ( unsigned long idx,
float & parameter ) const

◆ getSnoutPositionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getSnoutPositionTag ( ) const
inline

Definition at line 402 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getSurfaceEntryPoint() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getSurfaceEntryPoint ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getSurfaceEntryPoint() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getSurfaceEntryPoint ( unsigned long idx,
std::string & parameter ) const

◆ getSurfaceEntryPointTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getSurfaceEntryPointTag ( ) const
inline

Definition at line 408 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getTableTopLateralPosition() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopLateralPosition ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTableTopLateralPosition() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopLateralPosition ( unsigned long idx,
std::string & parameter ) const

◆ getTableTopLateralPositionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getTableTopLateralPositionTag ( ) const
inline

Definition at line 414 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getTableTopLongitudinalPosition() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopLongitudinalPosition ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTableTopLongitudinalPosition() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopLongitudinalPosition ( unsigned long idx,
std::string & parameter ) const

◆ getTableTopLongitudinalPositionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getTableTopLongitudinalPositionTag ( ) const
inline

Definition at line 420 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getTableTopPitchAngle() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopPitchAngle ( DCMTree::TreePtr item,
float & parameter ) const

◆ getTableTopPitchAngle() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopPitchAngle ( unsigned long idx,
float & parameter ) const

◆ getTableTopPitchAngleTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getTableTopPitchAngleTag ( ) const
inline

Definition at line 426 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getTableTopPitchRotationDirection() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopPitchRotationDirection ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTableTopPitchRotationDirection() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopPitchRotationDirection ( unsigned long idx,
std::string & parameter ) const

◆ getTableTopPitchRotationDirectionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getTableTopPitchRotationDirectionTag ( ) const
inline

Definition at line 432 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getTableTopRollAngle() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopRollAngle ( DCMTree::TreePtr item,
float & parameter ) const

◆ getTableTopRollAngle() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopRollAngle ( unsigned long idx,
float & parameter ) const

◆ getTableTopRollAngleTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getTableTopRollAngleTag ( ) const
inline

Definition at line 438 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getTableTopRollRotationDirection() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopRollRotationDirection ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTableTopRollRotationDirection() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopRollRotationDirection ( unsigned long idx,
std::string & parameter ) const

◆ getTableTopRollRotationDirectionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getTableTopRollRotationDirectionTag ( ) const
inline

Definition at line 444 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ getTableTopVerticalPosition() [1/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopVerticalPosition ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTableTopVerticalPosition() [2/2]

bool ml::DcmDRTIonControlPointSequenceInterface::getTableTopVerticalPosition ( unsigned long idx,
std::string & parameter ) const

◆ getTableTopVerticalPositionTag()

std::string ml::DcmDRTIonControlPointSequenceInterface::getTableTopVerticalPositionTag ( ) const
inline

Definition at line 450 of file mlDcmDRTIonControlPointSequenceInterface.h.

◆ hasSequence()

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

Check if the DRTIonControlPointSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 498 of file mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTIonControlPointSequenceInterface::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 mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTIonControlPointSequenceInterface::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 mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

◆ setBeamLimitingDeviceAngle()

bool ml::DcmDRTIonControlPointSequenceInterface::setBeamLimitingDeviceAngle ( unsigned long idx,
std::string parameter )

◆ setBeamLimitingDevicePositionSequence()

void ml::DcmDRTIonControlPointSequenceInterface::setBeamLimitingDevicePositionSequence ( DcmDRTBeamLimitingDevicePositionSequenceInterface seq,
unsigned long idx )

◆ setBeamLimitingDeviceRotationDirection()

bool ml::DcmDRTIonControlPointSequenceInterface::setBeamLimitingDeviceRotationDirection ( unsigned long idx,
std::string parameter )

◆ setControlPointIndex()

bool ml::DcmDRTIonControlPointSequenceInterface::setControlPointIndex ( unsigned long idx,
std::string parameter )

◆ setCumulativeMetersetWeight()

bool ml::DcmDRTIonControlPointSequenceInterface::setCumulativeMetersetWeight ( unsigned long idx,
std::string parameter )

◆ setGantryAngle()

bool ml::DcmDRTIonControlPointSequenceInterface::setGantryAngle ( unsigned long idx,
std::string parameter )

◆ setGantryPitchAngle()

bool ml::DcmDRTIonControlPointSequenceInterface::setGantryPitchAngle ( unsigned long idx,
float parameter )

◆ setGantryPitchRotationDirection()

bool ml::DcmDRTIonControlPointSequenceInterface::setGantryPitchRotationDirection ( unsigned long idx,
std::string parameter )

◆ setGantryRotationDirection()

bool ml::DcmDRTIonControlPointSequenceInterface::setGantryRotationDirection ( unsigned long idx,
std::string parameter )

◆ setHeadFixationAngle()

bool ml::DcmDRTIonControlPointSequenceInterface::setHeadFixationAngle ( unsigned long idx,
float parameter )

◆ setIonWedgePositionSequence()

void ml::DcmDRTIonControlPointSequenceInterface::setIonWedgePositionSequence ( DcmDRTIonWedgePositionSequenceInterface seq,
unsigned long idx )

◆ setIsocenterPosition()

bool ml::DcmDRTIonControlPointSequenceInterface::setIsocenterPosition ( unsigned long idx,
std::string parameter )

◆ setKVP()

bool ml::DcmDRTIonControlPointSequenceInterface::setKVP ( unsigned long idx,
std::string parameter )

◆ setLateralSpreadingDeviceSettingsSequence()

void ml::DcmDRTIonControlPointSequenceInterface::setLateralSpreadingDeviceSettingsSequence ( DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModuleInterface seq,
unsigned long idx )

◆ setMetersetRate()

bool ml::DcmDRTIonControlPointSequenceInterface::setMetersetRate ( unsigned long idx,
float parameter )

◆ setNominalBeamEnergy()

bool ml::DcmDRTIonControlPointSequenceInterface::setNominalBeamEnergy ( unsigned long idx,
std::string parameter )

◆ setNumberOfPaintings()

bool ml::DcmDRTIonControlPointSequenceInterface::setNumberOfPaintings ( unsigned long idx,
std::string parameter )

◆ setNumberOfScanSpotPositions()

bool ml::DcmDRTIonControlPointSequenceInterface::setNumberOfScanSpotPositions ( unsigned long idx,
std::string parameter )

◆ setPatientSupportAngle()

bool ml::DcmDRTIonControlPointSequenceInterface::setPatientSupportAngle ( unsigned long idx,
std::string parameter )

◆ setPatientSupportRotationDirection()

bool ml::DcmDRTIonControlPointSequenceInterface::setPatientSupportRotationDirection ( unsigned long idx,
std::string parameter )

◆ setRangeModulatorSettingsSequence()

void ml::DcmDRTIonControlPointSequenceInterface::setRangeModulatorSettingsSequence ( DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface seq,
unsigned long idx )

◆ setRangeShifterSettingsSequence()

void ml::DcmDRTIonControlPointSequenceInterface::setRangeShifterSettingsSequence ( DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface seq,
unsigned long idx )

◆ setReferencedDoseReferenceSequence()

void ml::DcmDRTIonControlPointSequenceInterface::setReferencedDoseReferenceSequence ( DcmDRTReferencedDoseReferenceSequenceInRTIonBeamsModuleInterface seq,
unsigned long idx )

◆ setScanningSpotSize()

bool ml::DcmDRTIonControlPointSequenceInterface::setScanningSpotSize ( unsigned long idx,
float parameter )

◆ setScanSpotMetersetWeights()

bool ml::DcmDRTIonControlPointSequenceInterface::setScanSpotMetersetWeights ( unsigned long idx,
float parameter )

◆ setScanSpotPositionMap()

bool ml::DcmDRTIonControlPointSequenceInterface::setScanSpotPositionMap ( unsigned long idx,
float parameter )

◆ setScanSpotTuneID()

bool ml::DcmDRTIonControlPointSequenceInterface::setScanSpotTuneID ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTIonControlPointSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIonControlPointSequence

Definition at line 486 of file mlDcmDRTIonControlPointSequenceInterface.h.

References _itemVec.

◆ setSnoutPosition()

bool ml::DcmDRTIonControlPointSequenceInterface::setSnoutPosition ( unsigned long idx,
float parameter )

◆ setSurfaceEntryPoint()

bool ml::DcmDRTIonControlPointSequenceInterface::setSurfaceEntryPoint ( unsigned long idx,
std::string parameter )

◆ setTableTopLateralPosition()

bool ml::DcmDRTIonControlPointSequenceInterface::setTableTopLateralPosition ( unsigned long idx,
std::string parameter )

◆ setTableTopLongitudinalPosition()

bool ml::DcmDRTIonControlPointSequenceInterface::setTableTopLongitudinalPosition ( unsigned long idx,
std::string parameter )

◆ setTableTopPitchAngle()

bool ml::DcmDRTIonControlPointSequenceInterface::setTableTopPitchAngle ( unsigned long idx,
float parameter )

◆ setTableTopPitchRotationDirection()

bool ml::DcmDRTIonControlPointSequenceInterface::setTableTopPitchRotationDirection ( unsigned long idx,
std::string parameter )

◆ setTableTopRollAngle()

bool ml::DcmDRTIonControlPointSequenceInterface::setTableTopRollAngle ( unsigned long idx,
float parameter )

◆ setTableTopRollRotationDirection()

bool ml::DcmDRTIonControlPointSequenceInterface::setTableTopRollRotationDirection ( unsigned long idx,
std::string parameter )

◆ setTableTopVerticalPosition()

bool ml::DcmDRTIonControlPointSequenceInterface::setTableTopVerticalPosition ( unsigned long idx,
std::string parameter )

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 554 of file mlDcmDRTIonControlPointSequenceInterface.h.

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

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