mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.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 __mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface_H
#define __mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface.h" //DRTRangeModulatorSettingsSequenceInRTIonBeamsModule
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface
{
  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; }
 
      
    // IsocenterToRangeModulatorDistance (300a,038a) vr=FL, vm=1, type=3
    bool getIsocenterToRangeModulatorDistance(float& parameter) const;
    std::string getIsocenterToRangeModulatorDistanceTag() const { return "(300a,038a)"; }
    bool setIsocenterToRangeModulatorDistance(float parameter);
    
    // RangeModulatorGatingStartValue (300a,0382) vr=FL, vm=1, type=1C
    bool getRangeModulatorGatingStartValue(float& parameter) const;
    std::string getRangeModulatorGatingStartValueTag() const { return "(300a,0382)"; }
    bool setRangeModulatorGatingStartValue(float parameter);
    
    // RangeModulatorGatingStartWaterEquivalentThickness (300a,0386) vr=FL, vm=1, type=3
    bool getRangeModulatorGatingStartWaterEquivalentThickness(float& parameter) const;
    std::string getRangeModulatorGatingStartWaterEquivalentThicknessTag() const { return "(300a,0386)"; }
    bool setRangeModulatorGatingStartWaterEquivalentThickness(float parameter);
    
    // RangeModulatorGatingStopValue (300a,0384) vr=FL, vm=1, type=1C
    bool getRangeModulatorGatingStopValue(float& parameter) const;
    std::string getRangeModulatorGatingStopValueTag() const { return "(300a,0384)"; }
    bool setRangeModulatorGatingStopValue(float parameter);
    
    // RangeModulatorGatingStopWaterEquivalentThickness (300a,0388) vr=FL, vm=1, type=3
    bool getRangeModulatorGatingStopWaterEquivalentThickness(float& parameter) const;
    std::string getRangeModulatorGatingStopWaterEquivalentThicknessTag() const { return "(300a,0388)"; }
    bool setRangeModulatorGatingStopWaterEquivalentThickness(float parameter);
    
    // ReferencedRangeModulatorNumber (300c,0104) vr=IS, vm=1, type=1
    bool getReferencedRangeModulatorNumber(std::string& parameter) const;
    std::string getReferencedRangeModulatorNumberTag() const { return "(300c,0104)"; }
    bool setReferencedRangeModulatorNumber(std::string parameter);
    
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface()  { }
    
    DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface(std::vector<DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface() {} 
    // IsocenterToRangeModulatorDistance (300a,038a) vr=FL, vm=1, type=3
    bool getIsocenterToRangeModulatorDistance(unsigned long idx, float& parameter) const;
    bool getIsocenterToRangeModulatorDistance(DCMTree::TreePtr item, float& parameter) const;
    std::string getIsocenterToRangeModulatorDistanceTag() const { return "(300a,038a)"; }
    bool setIsocenterToRangeModulatorDistance(unsigned long idx, float parameter);
    
    // RangeModulatorGatingStartValue (300a,0382) vr=FL, vm=1, type=1C
    bool getRangeModulatorGatingStartValue(unsigned long idx, float& parameter) const;
    bool getRangeModulatorGatingStartValue(DCMTree::TreePtr item, float& parameter) const;
    std::string getRangeModulatorGatingStartValueTag() const { return "(300a,0382)"; }
    bool setRangeModulatorGatingStartValue(unsigned long idx, float parameter);
    
    // RangeModulatorGatingStartWaterEquivalentThickness (300a,0386) vr=FL, vm=1, type=3
    bool getRangeModulatorGatingStartWaterEquivalentThickness(unsigned long idx, float& parameter) const;
    bool getRangeModulatorGatingStartWaterEquivalentThickness(DCMTree::TreePtr item, float& parameter) const;
    std::string getRangeModulatorGatingStartWaterEquivalentThicknessTag() const { return "(300a,0386)"; }
    bool setRangeModulatorGatingStartWaterEquivalentThickness(unsigned long idx, float parameter);
    
    // RangeModulatorGatingStopValue (300a,0384) vr=FL, vm=1, type=1C
    bool getRangeModulatorGatingStopValue(unsigned long idx, float& parameter) const;
    bool getRangeModulatorGatingStopValue(DCMTree::TreePtr item, float& parameter) const;
    std::string getRangeModulatorGatingStopValueTag() const { return "(300a,0384)"; }
    bool setRangeModulatorGatingStopValue(unsigned long idx, float parameter);
    
    // RangeModulatorGatingStopWaterEquivalentThickness (300a,0388) vr=FL, vm=1, type=3
    bool getRangeModulatorGatingStopWaterEquivalentThickness(unsigned long idx, float& parameter) const;
    bool getRangeModulatorGatingStopWaterEquivalentThickness(DCMTree::TreePtr item, float& parameter) const;
    std::string getRangeModulatorGatingStopWaterEquivalentThicknessTag() const { return "(300a,0388)"; }
    bool setRangeModulatorGatingStopWaterEquivalentThickness(unsigned long idx, float parameter);
    
    // ReferencedRangeModulatorNumber (300c,0104) vr=IS, vm=1, type=1
    bool getReferencedRangeModulatorNumber(unsigned long idx, std::string& parameter) const;
    bool getReferencedRangeModulatorNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedRangeModulatorNumberTag() const { return "(300c,0104)"; }
    bool setReferencedRangeModulatorNumber(unsigned long idx, std::string parameter);
     
    
    void setSequence(std::vector<DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item();
    }
    
    DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsModuleInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */