mlDcmDRTControlPointSequenceInterface.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------
//
// NOTE: 
// This file has been generated automatically by
//   FMEwork/ReleaseMeVis/Configuration/CodeGenerators/dcmtkToMLConverter/convertDcmtkToML.py
// using the template file
//   FMEwork/ReleaseMeVis/Configuration/CodeGenerators/dcmtkToMLConverter/MLDcmtkAccessoriesNew/templates/DcmSequenceInterface.h
//
// Destination project: 
//   FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessoriesNew/DcmSequenceInterfaces
//
//----------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------
 
#ifndef __mlDcmDRTControlPointSequenceInterface_H
#define __mlDcmDRTControlPointSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTControlPointSequenceInterface.h" //DRTControlPointSequence
#include "mlDcmDRTBeamLimitingDevicePositionSequenceInterface.h" //DRTBeamLimitingDevicePositionSequence
#include "mlDcmDRTReferencedDoseReferenceSequenceInRTBeamsModuleInterface.h" //DRTReferencedDoseReferenceSequenceInRTBeamsModule
#include "mlDcmDRTReferencedDoseSequenceInterface.h" //DRTReferencedDoseSequence
#include "mlDcmDRTWedgePositionSequenceInterface.h" //DRTWedgePositionSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTControlPointSequenceInterface
{
  public:
 
    class MLDCMTKACCESSORIES_EXPORT Item
    {
    public:
 
      Item() { _dcmItem = DcmtkAccessories::createNewDicomTree(); }
 
      Item(DCMTree::TreePtr dcmItem) : _dcmItem(dcmItem) {}
 
      Item(const Item &copyDcmItem) : _dcmItem(copyDcmItem.getTreePtr()) {}
 
      Item &operator=(const Item &copyDcmItem){ _dcmItem = copyDcmItem.getTreePtr(); return *this; }
 
      virtual ~Item() {}
 
      DCMTree::TreePtr getTreePtr() const { return _dcmItem; }
      
      bool isValid() const { return _dcmItem.get() != nullptr; }
 
      
    // BeamLimitingDeviceAngle (300a,0120) vr=DS, vm=1, type=1C
    bool getBeamLimitingDeviceAngle(std::string& parameter) const;
    std::string getBeamLimitingDeviceAngleTag() const { return "(300a,0120)"; }
    bool setBeamLimitingDeviceAngle(std::string parameter);
    
    // BeamLimitingDeviceRotationDirection (300a,0121) vr=CS, vm=1, type=1C
    bool getBeamLimitingDeviceRotationDirection(std::string& parameter) const;
    std::string getBeamLimitingDeviceRotationDirectionTag() const { return "(300a,0121)"; }
    bool setBeamLimitingDeviceRotationDirection(std::string parameter);
    
    // ControlPointIndex (300a,0112) vr=IS, vm=1, type=1C
    bool getControlPointIndex(std::string& parameter) const;
    std::string getControlPointIndexTag() const { return "(300a,0112)"; }
    bool setControlPointIndex(std::string parameter);
    
    // CumulativeMetersetWeight (300a,0134) vr=DS, vm=1, type=2C
    bool getCumulativeMetersetWeight(std::string& parameter) const;
    std::string getCumulativeMetersetWeightTag() const { return "(300a,0134)"; }
    bool setCumulativeMetersetWeight(std::string parameter);
    
    // DoseRateSet (300a,0115) vr=DS, vm=1, type=3
    bool getDoseRateSet(std::string& parameter) const;
    std::string getDoseRateSetTag() const { return "(300a,0115)"; }
    bool setDoseRateSet(std::string parameter);
    
    // GantryAngle (300a,011e) vr=DS, vm=1, type=1C
    bool getGantryAngle(std::string& parameter) const;
    std::string getGantryAngleTag() const { return "(300a,011e)"; }
    bool setGantryAngle(std::string parameter);
    
    // GantryPitchAngle (300a,014a) vr=FL, vm=1, type=3
    bool getGantryPitchAngle(float& parameter) const;
    std::string getGantryPitchAngleTag() const { return "(300a,014a)"; }
    bool setGantryPitchAngle(float parameter);
    
    // GantryPitchRotationDirection (300a,014c) vr=CS, vm=1, type=3
    bool getGantryPitchRotationDirection(std::string& parameter) const;
    std::string getGantryPitchRotationDirectionTag() const { return "(300a,014c)"; }
    bool setGantryPitchRotationDirection(std::string parameter);
    
    // GantryRotationDirection (300a,011f) vr=CS, vm=1, type=1C
    bool getGantryRotationDirection(std::string& parameter) const;
    std::string getGantryRotationDirectionTag() const { return "(300a,011f)"; }
    bool setGantryRotationDirection(std::string parameter);
    
    // IsocenterPosition (300a,012c) vr=DS, vm=3, type=2C
    bool getIsocenterPosition(std::string& parameter) const;
    std::string getIsocenterPositionTag() const { return "(300a,012c)"; }
    bool setIsocenterPosition(std::string parameter);
    
    // NominalBeamEnergy (300a,0114) vr=DS, vm=1, type=3
    bool getNominalBeamEnergy(std::string& parameter) const;
    std::string getNominalBeamEnergyTag() const { return "(300a,0114)"; }
    bool setNominalBeamEnergy(std::string parameter);
    
    // PatientSupportAngle (300a,0122) vr=DS, vm=1, type=1C
    bool getPatientSupportAngle(std::string& parameter) const;
    std::string getPatientSupportAngleTag() const { return "(300a,0122)"; }
    bool setPatientSupportAngle(std::string parameter);
    
    // PatientSupportRotationDirection (300a,0123) vr=CS, vm=1, type=1C
    bool getPatientSupportRotationDirection(std::string& parameter) const;
    std::string getPatientSupportRotationDirectionTag() const { return "(300a,0123)"; }
    bool setPatientSupportRotationDirection(std::string parameter);
    
    // SourceToSurfaceDistance (300a,0130) vr=DS, vm=1, type=3
    bool getSourceToSurfaceDistance(std::string& parameter) const;
    std::string getSourceToSurfaceDistanceTag() const { return "(300a,0130)"; }
    bool setSourceToSurfaceDistance(std::string parameter);
    
    // SurfaceEntryPoint (300a,012e) vr=DS, vm=3, type=3
    bool getSurfaceEntryPoint(std::string& parameter) const;
    std::string getSurfaceEntryPointTag() const { return "(300a,012e)"; }
    bool setSurfaceEntryPoint(std::string parameter);
    
    // TableTopEccentricAngle (300a,0125) vr=DS, vm=1, type=1C
    bool getTableTopEccentricAngle(std::string& parameter) const;
    std::string getTableTopEccentricAngleTag() const { return "(300a,0125)"; }
    bool setTableTopEccentricAngle(std::string parameter);
    
    // TableTopEccentricAxisDistance (300a,0124) vr=DS, vm=1, type=3
    bool getTableTopEccentricAxisDistance(std::string& parameter) const;
    std::string getTableTopEccentricAxisDistanceTag() const { return "(300a,0124)"; }
    bool setTableTopEccentricAxisDistance(std::string parameter);
    
    // TableTopEccentricRotationDirection (300a,0126) vr=CS, vm=1, type=1C
    bool getTableTopEccentricRotationDirection(std::string& parameter) const;
    std::string getTableTopEccentricRotationDirectionTag() const { return "(300a,0126)"; }
    bool setTableTopEccentricRotationDirection(std::string parameter);
    
    // TableTopLateralPosition (300a,012a) vr=DS, vm=1, type=2C
    bool getTableTopLateralPosition(std::string& parameter) const;
    std::string getTableTopLateralPositionTag() const { return "(300a,012a)"; }
    bool setTableTopLateralPosition(std::string parameter);
    
    // TableTopLongitudinalPosition (300a,0129) vr=DS, vm=1, type=2C
    bool getTableTopLongitudinalPosition(std::string& parameter) const;
    std::string getTableTopLongitudinalPositionTag() const { return "(300a,0129)"; }
    bool setTableTopLongitudinalPosition(std::string parameter);
    
    // TableTopVerticalPosition (300a,0128) vr=DS, vm=1, type=2C
    bool getTableTopVerticalPosition(std::string& parameter) const;
    std::string getTableTopVerticalPositionTag() const { return "(300a,0128)"; }
    bool setTableTopVerticalPosition(std::string parameter);
    
    // BeamLimitingDevicePositionSequence (300a,011a) vr=SQ, vm=1, type=1C
    DcmDRTBeamLimitingDevicePositionSequenceInterface getBeamLimitingDevicePositionSequence() const;
    std::string getBeamLimitingDevicePositionSequenceTag() const { return std::string("(300a,011a)"); }
    void setBeamLimitingDevicePositionSequence(DcmDRTBeamLimitingDevicePositionSequenceInterface seq);
 
    // ReferencedDoseReferenceSequence (300c,0050) vr=SQ, vm=1, type=3
    DcmDRTReferencedDoseReferenceSequenceInRTBeamsModuleInterface getReferencedDoseReferenceSequence() const;
    std::string getReferencedDoseReferenceSequenceTag() const { return std::string("(300c,0050)"); }
    void setReferencedDoseReferenceSequence(DcmDRTReferencedDoseReferenceSequenceInRTBeamsModuleInterface seq);
 
    // ReferencedDoseSequence (300c,0080) vr=SQ, vm=1, type=1C
    DcmDRTReferencedDoseSequenceInterface getReferencedDoseSequence() const;
    std::string getReferencedDoseSequenceTag() const { return std::string("(300c,0080)"); }
    void setReferencedDoseSequence(DcmDRTReferencedDoseSequenceInterface seq);
 
    // WedgePositionSequence (300a,0116) vr=SQ, vm=1, type=3
    DcmDRTWedgePositionSequenceInterface getWedgePositionSequence() const;
    std::string getWedgePositionSequenceTag() const { return std::string("(300a,0116)"); }
    void setWedgePositionSequence(DcmDRTWedgePositionSequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTControlPointSequenceInterface()  { }
    
    DcmDRTControlPointSequenceInterface(std::vector<DcmDRTControlPointSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTControlPointSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTControlPointSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTControlPointSequenceInterface() {} 
    // BeamLimitingDeviceAngle (300a,0120) vr=DS, vm=1, type=1C
    bool getBeamLimitingDeviceAngle(unsigned long idx, std::string& parameter) const;
    bool getBeamLimitingDeviceAngle(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBeamLimitingDeviceAngleTag() const { return "(300a,0120)"; }
    bool setBeamLimitingDeviceAngle(unsigned long idx, std::string parameter);
    
    // BeamLimitingDeviceRotationDirection (300a,0121) vr=CS, vm=1, type=1C
    bool getBeamLimitingDeviceRotationDirection(unsigned long idx, std::string& parameter) const;
    bool getBeamLimitingDeviceRotationDirection(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBeamLimitingDeviceRotationDirectionTag() const { return "(300a,0121)"; }
    bool setBeamLimitingDeviceRotationDirection(unsigned long idx, std::string parameter);
    
    // ControlPointIndex (300a,0112) vr=IS, vm=1, type=1C
    bool getControlPointIndex(unsigned long idx, std::string& parameter) const;
    bool getControlPointIndex(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getControlPointIndexTag() const { return "(300a,0112)"; }
    bool setControlPointIndex(unsigned long idx, std::string parameter);
    
    // CumulativeMetersetWeight (300a,0134) vr=DS, vm=1, type=2C
    bool getCumulativeMetersetWeight(unsigned long idx, std::string& parameter) const;
    bool getCumulativeMetersetWeight(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCumulativeMetersetWeightTag() const { return "(300a,0134)"; }
    bool setCumulativeMetersetWeight(unsigned long idx, std::string parameter);
    
    // DoseRateSet (300a,0115) vr=DS, vm=1, type=3
    bool getDoseRateSet(unsigned long idx, std::string& parameter) const;
    bool getDoseRateSet(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDoseRateSetTag() const { return "(300a,0115)"; }
    bool setDoseRateSet(unsigned long idx, std::string parameter);
    
    // GantryAngle (300a,011e) vr=DS, vm=1, type=1C
    bool getGantryAngle(unsigned long idx, std::string& parameter) const;
    bool getGantryAngle(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getGantryAngleTag() const { return "(300a,011e)"; }
    bool setGantryAngle(unsigned long idx, std::string parameter);
    
    // GantryPitchAngle (300a,014a) vr=FL, vm=1, type=3
    bool getGantryPitchAngle(unsigned long idx, float& parameter) const;
    bool getGantryPitchAngle(DCMTree::TreePtr item, float& parameter) const;
    std::string getGantryPitchAngleTag() const { return "(300a,014a)"; }
    bool setGantryPitchAngle(unsigned long idx, float parameter);
    
    // GantryPitchRotationDirection (300a,014c) vr=CS, vm=1, type=3
    bool getGantryPitchRotationDirection(unsigned long idx, std::string& parameter) const;
    bool getGantryPitchRotationDirection(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getGantryPitchRotationDirectionTag() const { return "(300a,014c)"; }
    bool setGantryPitchRotationDirection(unsigned long idx, std::string parameter);
    
    // GantryRotationDirection (300a,011f) vr=CS, vm=1, type=1C
    bool getGantryRotationDirection(unsigned long idx, std::string& parameter) const;
    bool getGantryRotationDirection(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getGantryRotationDirectionTag() const { return "(300a,011f)"; }
    bool setGantryRotationDirection(unsigned long idx, std::string parameter);
    
    // IsocenterPosition (300a,012c) vr=DS, vm=3, type=2C
    bool getIsocenterPosition(unsigned long idx, std::string& parameter) const;
    bool getIsocenterPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getIsocenterPositionTag() const { return "(300a,012c)"; }
    bool setIsocenterPosition(unsigned long idx, std::string parameter);
    
    // NominalBeamEnergy (300a,0114) vr=DS, vm=1, type=3
    bool getNominalBeamEnergy(unsigned long idx, std::string& parameter) const;
    bool getNominalBeamEnergy(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNominalBeamEnergyTag() const { return "(300a,0114)"; }
    bool setNominalBeamEnergy(unsigned long idx, std::string parameter);
    
    // PatientSupportAngle (300a,0122) vr=DS, vm=1, type=1C
    bool getPatientSupportAngle(unsigned long idx, std::string& parameter) const;
    bool getPatientSupportAngle(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPatientSupportAngleTag() const { return "(300a,0122)"; }
    bool setPatientSupportAngle(unsigned long idx, std::string parameter);
    
    // PatientSupportRotationDirection (300a,0123) vr=CS, vm=1, type=1C
    bool getPatientSupportRotationDirection(unsigned long idx, std::string& parameter) const;
    bool getPatientSupportRotationDirection(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPatientSupportRotationDirectionTag() const { return "(300a,0123)"; }
    bool setPatientSupportRotationDirection(unsigned long idx, std::string parameter);
    
    // SourceToSurfaceDistance (300a,0130) vr=DS, vm=1, type=3
    bool getSourceToSurfaceDistance(unsigned long idx, std::string& parameter) const;
    bool getSourceToSurfaceDistance(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceToSurfaceDistanceTag() const { return "(300a,0130)"; }
    bool setSourceToSurfaceDistance(unsigned long idx, std::string parameter);
    
    // SurfaceEntryPoint (300a,012e) vr=DS, vm=3, type=3
    bool getSurfaceEntryPoint(unsigned long idx, std::string& parameter) const;
    bool getSurfaceEntryPoint(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSurfaceEntryPointTag() const { return "(300a,012e)"; }
    bool setSurfaceEntryPoint(unsigned long idx, std::string parameter);
    
    // TableTopEccentricAngle (300a,0125) vr=DS, vm=1, type=1C
    bool getTableTopEccentricAngle(unsigned long idx, std::string& parameter) const;
    bool getTableTopEccentricAngle(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTableTopEccentricAngleTag() const { return "(300a,0125)"; }
    bool setTableTopEccentricAngle(unsigned long idx, std::string parameter);
    
    // TableTopEccentricAxisDistance (300a,0124) vr=DS, vm=1, type=3
    bool getTableTopEccentricAxisDistance(unsigned long idx, std::string& parameter) const;
    bool getTableTopEccentricAxisDistance(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTableTopEccentricAxisDistanceTag() const { return "(300a,0124)"; }
    bool setTableTopEccentricAxisDistance(unsigned long idx, std::string parameter);
    
    // TableTopEccentricRotationDirection (300a,0126) vr=CS, vm=1, type=1C
    bool getTableTopEccentricRotationDirection(unsigned long idx, std::string& parameter) const;
    bool getTableTopEccentricRotationDirection(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTableTopEccentricRotationDirectionTag() const { return "(300a,0126)"; }
    bool setTableTopEccentricRotationDirection(unsigned long idx, std::string parameter);
    
    // TableTopLateralPosition (300a,012a) vr=DS, vm=1, type=2C
    bool getTableTopLateralPosition(unsigned long idx, std::string& parameter) const;
    bool getTableTopLateralPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTableTopLateralPositionTag() const { return "(300a,012a)"; }
    bool setTableTopLateralPosition(unsigned long idx, std::string parameter);
    
    // TableTopLongitudinalPosition (300a,0129) vr=DS, vm=1, type=2C
    bool getTableTopLongitudinalPosition(unsigned long idx, std::string& parameter) const;
    bool getTableTopLongitudinalPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTableTopLongitudinalPositionTag() const { return "(300a,0129)"; }
    bool setTableTopLongitudinalPosition(unsigned long idx, std::string parameter);
    
    // TableTopVerticalPosition (300a,0128) vr=DS, vm=1, type=2C
    bool getTableTopVerticalPosition(unsigned long idx, std::string& parameter) const;
    bool getTableTopVerticalPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTableTopVerticalPositionTag() const { return "(300a,0128)"; }
    bool setTableTopVerticalPosition(unsigned long idx, std::string parameter);
     
    // BeamLimitingDevicePositionSequence (300a,011a) vr=SQ, vm=1, type=1C
    DcmDRTBeamLimitingDevicePositionSequenceInterface getBeamLimitingDevicePositionSequence(unsigned long idx) const;
    std::string getBeamLimitingDevicePositionSequenceTag() const { return std::string("(300a,011a)"); }
    void setBeamLimitingDevicePositionSequence(DcmDRTBeamLimitingDevicePositionSequenceInterface seq, unsigned long idx);
 
    // ReferencedDoseReferenceSequence (300c,0050) vr=SQ, vm=1, type=3
    DcmDRTReferencedDoseReferenceSequenceInRTBeamsModuleInterface getReferencedDoseReferenceSequence(unsigned long idx) const;
    std::string getReferencedDoseReferenceSequenceTag() const { return std::string("(300c,0050)"); }
    void setReferencedDoseReferenceSequence(DcmDRTReferencedDoseReferenceSequenceInRTBeamsModuleInterface seq, unsigned long idx);
 
    // ReferencedDoseSequence (300c,0080) vr=SQ, vm=1, type=1C
    DcmDRTReferencedDoseSequenceInterface getReferencedDoseSequence(unsigned long idx) const;
    std::string getReferencedDoseSequenceTag() const { return std::string("(300c,0080)"); }
    void setReferencedDoseSequence(DcmDRTReferencedDoseSequenceInterface seq, unsigned long idx);
 
    // WedgePositionSequence (300a,0116) vr=SQ, vm=1, type=3
    DcmDRTWedgePositionSequenceInterface getWedgePositionSequence(unsigned long idx) const;
    std::string getWedgePositionSequenceTag() const { return std::string("(300a,0116)"); }
    void setWedgePositionSequence(DcmDRTWedgePositionSequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTControlPointSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTControlPointSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTControlPointSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTControlPointSequenceInterface::Item();
    }
    
    DcmDRTControlPointSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTControlPointSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTControlPointSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTControlPointSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTControlPointSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTControlPointSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTControlPointSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTControlPointSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */