MeVisLab Toolbox Reference
ml::DcmDRTIonControlPointDeliverySequenceInterface Class Reference

Class to provide access to DRTIonControlPointDeliverySequence. More...

#include <mlDcmDRTIonControlPointDeliverySequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTIonControlPointDeliverySequenceInterface ()
 
 DcmDRTIonControlPointDeliverySequenceInterface (std::vector< DcmDRTIonControlPointDeliverySequenceInterface::Item > dcmSequence)
 Default Constructor.
 
 DcmDRTIonControlPointDeliverySequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTIonControlPointDeliverySequenceInterface ()
 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 getDeliveredMeterset (unsigned long idx, std::string &parameter) const
 
bool getDeliveredMeterset (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDeliveredMetersetTag () const
 
bool setDeliveredMeterset (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 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 getMetersetRateDelivered (unsigned long idx, float &parameter) const
 
bool getMetersetRateDelivered (DCMTree::TreePtr item, float &parameter) const
 
std::string getMetersetRateDeliveredTag () const
 
bool setMetersetRateDelivered (unsigned long idx, float parameter)
 
bool getMetersetRateSet (unsigned long idx, float &parameter) const
 
bool getMetersetRateSet (DCMTree::TreePtr item, float &parameter) const
 
std::string getMetersetRateSetTag () const
 
bool setMetersetRateSet (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 getReferencedControlPointIndex (unsigned long idx, std::string &parameter) const
 
bool getReferencedControlPointIndex (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getReferencedControlPointIndexTag () const
 
bool setReferencedControlPointIndex (unsigned long idx, std::string parameter)
 
bool getScanSpotMetersetsDelivered (unsigned long idx, float &parameter) const
 
bool getScanSpotMetersetsDelivered (DCMTree::TreePtr item, float &parameter) const
 
std::string getScanSpotMetersetsDeliveredTag () const
 
bool setScanSpotMetersetsDelivered (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 getSpecifiedMeterset (unsigned long idx, std::string &parameter) const
 
bool getSpecifiedMeterset (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getSpecifiedMetersetTag () const
 
bool setSpecifiedMeterset (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)
 
bool getTreatmentControlPointDate (unsigned long idx, std::string &parameter) const
 
bool getTreatmentControlPointDate (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getTreatmentControlPointDateTag () const
 
bool setTreatmentControlPointDate (unsigned long idx, std::string parameter)
 
bool getTreatmentControlPointTime (unsigned long idx, std::string &parameter) const
 
bool getTreatmentControlPointTime (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getTreatmentControlPointTimeTag () const
 
bool setTreatmentControlPointTime (unsigned long idx, std::string parameter)
 
DcmDRTBeamLimitingDevicePositionSequenceInterface getBeamLimitingDevicePositionSequence (unsigned long idx) const
 
std::string getBeamLimitingDevicePositionSequenceTag () const
 
void setBeamLimitingDevicePositionSequence (DcmDRTBeamLimitingDevicePositionSequenceInterface seq, unsigned long idx)
 
DcmDRTCorrectedParameterSequenceInterface getCorrectedParameterSequence (unsigned long idx) const
 
std::string getCorrectedParameterSequenceTag () const
 
void setCorrectedParameterSequence (DcmDRTCorrectedParameterSequenceInterface seq, unsigned long idx)
 
DcmDRTIonWedgePositionSequenceInterface getIonWedgePositionSequence (unsigned long idx) const
 
std::string getIonWedgePositionSequenceTag () const
 
void setIonWedgePositionSequence (DcmDRTIonWedgePositionSequenceInterface seq, unsigned long idx)
 
DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface getLateralSpreadingDeviceSettingsSequence (unsigned long idx) const
 
std::string getLateralSpreadingDeviceSettingsSequenceTag () const
 
void setLateralSpreadingDeviceSettingsSequence (DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface seq, unsigned long idx)
 
DcmDRTOverrideSequenceInterface getOverrideSequence (unsigned long idx) const
 
std::string getOverrideSequenceTag () const
 
void setOverrideSequence (DcmDRTOverrideSequenceInterface seq, unsigned long idx)
 
DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface getRangeModulatorSettingsSequence (unsigned long idx) const
 
std::string getRangeModulatorSettingsSequenceTag () const
 
void setRangeModulatorSettingsSequence (DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface seq, unsigned long idx)
 
DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface getRangeShifterSettingsSequence (unsigned long idx) const
 
std::string getRangeShifterSettingsSequenceTag () const
 
void setRangeShifterSettingsSequence (DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface seq, unsigned long idx)
 
void setSequence (std::vector< DcmDRTIonControlPointDeliverySequenceInterface::Item > dcmSequence)
 Set the DRTIonControlPointDeliverySequence this interface class provides access to.
 
std::vector< DcmDRTIonControlPointDeliverySequenceInterface::ItemgetSequence () const
 Return the DRTIonControlPointDeliverySequence this interface class provides access to.
 
bool hasSequence () const
 Check if the DRTIonControlPointDeliverySequence is set.
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
 
DcmDRTIonControlPointDeliverySequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position.
 
DcmDRTIonControlPointDeliverySequenceInterface::ItemaddItem ()
 Adds a new item to the sequence.
 
void addItem (DcmDRTIonControlPointDeliverySequenceInterface::Item newItem)
 
bool insertItem (const size_t idx)
 Insert an item at the indicated position.
 
bool removeItem (const size_t idx)
 Removes the indicated item from the sequence.
 

Protected Attributes

std::vector< DcmDRTIonControlPointDeliverySequenceInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector.
 

Detailed Description

Class to provide access to DRTIonControlPointDeliverySequence.

Definition at line 50 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTIonControlPointDeliverySequenceInterface() [1/3]

ml::DcmDRTIonControlPointDeliverySequenceInterface::DcmDRTIonControlPointDeliverySequenceInterface ( )
inline

◆ DcmDRTIonControlPointDeliverySequenceInterface() [2/3]

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

Default Constructor.

Definition at line 278 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

◆ DcmDRTIonControlPointDeliverySequenceInterface() [3/3]

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

◆ ~DcmDRTIonControlPointDeliverySequenceInterface()

virtual ml::DcmDRTIonControlPointDeliverySequenceInterface::~DcmDRTIonControlPointDeliverySequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 288 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 552 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

◆ addItem() [2/2]

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

◆ getBeamLimitingDeviceAngle() [1/2]

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

◆ getBeamLimitingDeviceAngle() [2/2]

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

◆ getBeamLimitingDeviceAngleTag()

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

◆ getBeamLimitingDevicePositionSequence()

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

◆ getBeamLimitingDevicePositionSequenceTag()

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

◆ getBeamLimitingDeviceRotationDirection() [1/2]

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

◆ getBeamLimitingDeviceRotationDirection() [2/2]

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

◆ getBeamLimitingDeviceRotationDirectionTag()

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

◆ getCorrectedParameterSequence()

DcmDRTCorrectedParameterSequenceInterface ml::DcmDRTIonControlPointDeliverySequenceInterface::getCorrectedParameterSequence ( unsigned long idx) const

◆ getCorrectedParameterSequenceTag()

std::string ml::DcmDRTIonControlPointDeliverySequenceInterface::getCorrectedParameterSequenceTag ( ) const
inline

◆ getDeliveredMeterset() [1/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getDeliveredMeterset ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getDeliveredMeterset() [2/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getDeliveredMeterset ( unsigned long idx,
std::string & parameter ) const

◆ getDeliveredMetersetTag()

std::string ml::DcmDRTIonControlPointDeliverySequenceInterface::getDeliveredMetersetTag ( ) const
inline

◆ getGantryAngle() [1/2]

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

◆ getGantryAngle() [2/2]

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

◆ getGantryAngleTag()

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

◆ getGantryPitchAngle() [1/2]

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

◆ getGantryPitchAngle() [2/2]

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

◆ getGantryPitchAngleTag()

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

◆ getGantryPitchRotationDirection() [1/2]

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

◆ getGantryPitchRotationDirection() [2/2]

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

◆ getGantryPitchRotationDirectionTag()

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

◆ getGantryRotationDirection() [1/2]

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

◆ getGantryRotationDirection() [2/2]

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

◆ getGantryRotationDirectionTag()

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

◆ getHeadFixationAngle() [1/2]

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

◆ getHeadFixationAngle() [2/2]

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

◆ getHeadFixationAngleTag()

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

◆ getIonWedgePositionSequence()

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

◆ getIonWedgePositionSequenceTag()

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

◆ getItem()

DcmDRTIonControlPointDeliverySequenceInterface::Item ml::DcmDRTIonControlPointDeliverySequenceInterface::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 543 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

References mlrange_cast().

◆ getKVP() [1/2]

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

◆ getKVP() [2/2]

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

◆ getKVPTag()

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

◆ getLateralSpreadingDeviceSettingsSequence()

DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ml::DcmDRTIonControlPointDeliverySequenceInterface::getLateralSpreadingDeviceSettingsSequence ( unsigned long idx) const

◆ getLateralSpreadingDeviceSettingsSequenceTag()

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

◆ getMetersetRateDelivered() [1/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getMetersetRateDelivered ( DCMTree::TreePtr item,
float & parameter ) const

◆ getMetersetRateDelivered() [2/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getMetersetRateDelivered ( unsigned long idx,
float & parameter ) const

◆ getMetersetRateDeliveredTag()

std::string ml::DcmDRTIonControlPointDeliverySequenceInterface::getMetersetRateDeliveredTag ( ) const
inline

◆ getMetersetRateSet() [1/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getMetersetRateSet ( DCMTree::TreePtr item,
float & parameter ) const

◆ getMetersetRateSet() [2/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getMetersetRateSet ( unsigned long idx,
float & parameter ) const

◆ getMetersetRateSetTag()

std::string ml::DcmDRTIonControlPointDeliverySequenceInterface::getMetersetRateSetTag ( ) const
inline

◆ getNominalBeamEnergy() [1/2]

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

◆ getNominalBeamEnergy() [2/2]

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

◆ getNominalBeamEnergyTag()

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

◆ getNumberOfItems()

MLint ml::DcmDRTIonControlPointDeliverySequenceInterface::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 537 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

◆ getNumberOfPaintings() [1/2]

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

◆ getNumberOfPaintings() [2/2]

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

◆ getNumberOfPaintingsTag()

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

◆ getNumberOfScanSpotPositions() [1/2]

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

◆ getNumberOfScanSpotPositions() [2/2]

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

◆ getNumberOfScanSpotPositionsTag()

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

◆ getOverrideSequence()

DcmDRTOverrideSequenceInterface ml::DcmDRTIonControlPointDeliverySequenceInterface::getOverrideSequence ( unsigned long idx) const

◆ getOverrideSequenceTag()

std::string ml::DcmDRTIonControlPointDeliverySequenceInterface::getOverrideSequenceTag ( ) const
inline

◆ getPatientSupportAngle() [1/2]

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

◆ getPatientSupportAngle() [2/2]

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

◆ getPatientSupportAngleTag()

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

◆ getPatientSupportRotationDirection() [1/2]

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

◆ getPatientSupportRotationDirection() [2/2]

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

◆ getPatientSupportRotationDirectionTag()

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

◆ getRangeModulatorSettingsSequence()

DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ml::DcmDRTIonControlPointDeliverySequenceInterface::getRangeModulatorSettingsSequence ( unsigned long idx) const

◆ getRangeModulatorSettingsSequenceTag()

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

◆ getRangeShifterSettingsSequence()

DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ml::DcmDRTIonControlPointDeliverySequenceInterface::getRangeShifterSettingsSequence ( unsigned long idx) const

◆ getRangeShifterSettingsSequenceTag()

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

◆ getReferencedControlPointIndex() [1/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getReferencedControlPointIndex ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReferencedControlPointIndex() [2/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getReferencedControlPointIndex ( unsigned long idx,
std::string & parameter ) const

◆ getReferencedControlPointIndexTag()

std::string ml::DcmDRTIonControlPointDeliverySequenceInterface::getReferencedControlPointIndexTag ( ) const
inline

◆ getScanningSpotSize() [1/2]

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

◆ getScanningSpotSize() [2/2]

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

◆ getScanningSpotSizeTag()

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

◆ getScanSpotMetersetsDelivered() [1/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getScanSpotMetersetsDelivered ( DCMTree::TreePtr item,
float & parameter ) const

◆ getScanSpotMetersetsDelivered() [2/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getScanSpotMetersetsDelivered ( unsigned long idx,
float & parameter ) const

◆ getScanSpotMetersetsDeliveredTag()

std::string ml::DcmDRTIonControlPointDeliverySequenceInterface::getScanSpotMetersetsDeliveredTag ( ) const
inline

◆ getScanSpotPositionMap() [1/2]

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

◆ getScanSpotPositionMap() [2/2]

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

◆ getScanSpotPositionMapTag()

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

◆ getScanSpotTuneID() [1/2]

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

◆ getScanSpotTuneID() [2/2]

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

◆ getScanSpotTuneIDTag()

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

◆ getSequence()

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

Return the DRTIonControlPointDeliverySequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIonControlPointDeliverySequence

Definition at line 525 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

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

◆ getSnoutPosition() [1/2]

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

◆ getSnoutPosition() [2/2]

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

◆ getSnoutPositionTag()

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

◆ getSpecifiedMeterset() [1/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getSpecifiedMeterset ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getSpecifiedMeterset() [2/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getSpecifiedMeterset ( unsigned long idx,
std::string & parameter ) const

◆ getSpecifiedMetersetTag()

std::string ml::DcmDRTIonControlPointDeliverySequenceInterface::getSpecifiedMetersetTag ( ) const
inline

◆ getTableTopLateralPosition() [1/2]

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

◆ getTableTopLateralPosition() [2/2]

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

◆ getTableTopLateralPositionTag()

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

◆ getTableTopLongitudinalPosition() [1/2]

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

◆ getTableTopLongitudinalPosition() [2/2]

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

◆ getTableTopLongitudinalPositionTag()

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

◆ getTableTopPitchAngle() [1/2]

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

◆ getTableTopPitchAngle() [2/2]

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

◆ getTableTopPitchAngleTag()

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

◆ getTableTopPitchRotationDirection() [1/2]

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

◆ getTableTopPitchRotationDirection() [2/2]

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

◆ getTableTopPitchRotationDirectionTag()

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

◆ getTableTopRollAngle() [1/2]

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

◆ getTableTopRollAngle() [2/2]

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

◆ getTableTopRollAngleTag()

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

◆ getTableTopRollRotationDirection() [1/2]

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

◆ getTableTopRollRotationDirection() [2/2]

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

◆ getTableTopRollRotationDirectionTag()

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

◆ getTableTopVerticalPosition() [1/2]

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

◆ getTableTopVerticalPosition() [2/2]

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

◆ getTableTopVerticalPositionTag()

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

◆ getTreatmentControlPointDate() [1/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getTreatmentControlPointDate ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTreatmentControlPointDate() [2/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getTreatmentControlPointDate ( unsigned long idx,
std::string & parameter ) const

◆ getTreatmentControlPointDateTag()

std::string ml::DcmDRTIonControlPointDeliverySequenceInterface::getTreatmentControlPointDateTag ( ) const
inline

◆ getTreatmentControlPointTime() [1/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getTreatmentControlPointTime ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTreatmentControlPointTime() [2/2]

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::getTreatmentControlPointTime ( unsigned long idx,
std::string & parameter ) const

◆ getTreatmentControlPointTimeTag()

std::string ml::DcmDRTIonControlPointDeliverySequenceInterface::getTreatmentControlPointTimeTag ( ) const
inline

◆ hasSequence()

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

Check if the DRTIonControlPointDeliverySequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 531 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::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 563 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

References mlrange_cast().

◆ removeItem()

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::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 575 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

References mlrange_cast().

◆ setBeamLimitingDeviceAngle()

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

◆ setBeamLimitingDevicePositionSequence()

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

◆ setBeamLimitingDeviceRotationDirection()

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

◆ setCorrectedParameterSequence()

void ml::DcmDRTIonControlPointDeliverySequenceInterface::setCorrectedParameterSequence ( DcmDRTCorrectedParameterSequenceInterface seq,
unsigned long idx )

◆ setDeliveredMeterset()

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::setDeliveredMeterset ( unsigned long idx,
std::string parameter )

◆ setGantryAngle()

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

◆ setGantryPitchAngle()

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

◆ setGantryPitchRotationDirection()

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

◆ setGantryRotationDirection()

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

◆ setHeadFixationAngle()

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

◆ setIonWedgePositionSequence()

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

◆ setKVP()

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

◆ setLateralSpreadingDeviceSettingsSequence()

void ml::DcmDRTIonControlPointDeliverySequenceInterface::setLateralSpreadingDeviceSettingsSequence ( DcmDRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsSessionRecordModuleInterface seq,
unsigned long idx )

◆ setMetersetRateDelivered()

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::setMetersetRateDelivered ( unsigned long idx,
float parameter )

◆ setMetersetRateSet()

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::setMetersetRateSet ( unsigned long idx,
float parameter )

◆ setNominalBeamEnergy()

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

◆ setNumberOfPaintings()

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

◆ setNumberOfScanSpotPositions()

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

◆ setOverrideSequence()

void ml::DcmDRTIonControlPointDeliverySequenceInterface::setOverrideSequence ( DcmDRTOverrideSequenceInterface seq,
unsigned long idx )

◆ setPatientSupportAngle()

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

◆ setPatientSupportRotationDirection()

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

◆ setRangeModulatorSettingsSequence()

void ml::DcmDRTIonControlPointDeliverySequenceInterface::setRangeModulatorSettingsSequence ( DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface seq,
unsigned long idx )

◆ setRangeShifterSettingsSequence()

void ml::DcmDRTIonControlPointDeliverySequenceInterface::setRangeShifterSettingsSequence ( DcmDRTRangeShifterSettingsSequenceInRTIonBeamsSessionRecordModuleInterface seq,
unsigned long idx )

◆ setReferencedControlPointIndex()

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::setReferencedControlPointIndex ( unsigned long idx,
std::string parameter )

◆ setScanningSpotSize()

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

◆ setScanSpotMetersetsDelivered()

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::setScanSpotMetersetsDelivered ( unsigned long idx,
float parameter )

◆ setScanSpotPositionMap()

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

◆ setScanSpotTuneID()

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

◆ setSequence()

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

Set the DRTIonControlPointDeliverySequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIonControlPointDeliverySequence

Definition at line 519 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.

References mlrange_cast().

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

◆ setSnoutPosition()

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

◆ setSpecifiedMeterset()

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::setSpecifiedMeterset ( unsigned long idx,
std::string parameter )

◆ setTableTopLateralPosition()

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

◆ setTableTopLongitudinalPosition()

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

◆ setTableTopPitchAngle()

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

◆ setTableTopPitchRotationDirection()

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

◆ setTableTopRollAngle()

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

◆ setTableTopRollRotationDirection()

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

◆ setTableTopVerticalPosition()

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

◆ setTreatmentControlPointDate()

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::setTreatmentControlPointDate ( unsigned long idx,
std::string parameter )

◆ setTreatmentControlPointTime()

bool ml::DcmDRTIonControlPointDeliverySequenceInterface::setTreatmentControlPointTime ( unsigned long idx,
std::string parameter )

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 587 of file mlDcmDRTIonControlPointDeliverySequenceInterface.h.


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