mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.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 __mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface_H
#define __mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h" //DRTReferencedBeamSequenceInRTFractionSchemeModule
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface
{
  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; }
 
      
    // BeamDose (300a,0084) vr=DS, vm=1, type=3
    bool getBeamDose(std::string& parameter) const;
    std::string getBeamDoseTag() const { return "(300a,0084)"; }
    bool setBeamDose(std::string parameter);
    
    // BeamDosePointDepth (300a,0088) vr=FL, vm=1, type=3
    bool getBeamDosePointDepth(float& parameter) const;
    std::string getBeamDosePointDepthTag() const { return "(300a,0088)"; }
    bool setBeamDosePointDepth(float parameter);
    
    // BeamDosePointEquivalentDepth (300a,0089) vr=FL, vm=1, type=3
    bool getBeamDosePointEquivalentDepth(float& parameter) const;
    std::string getBeamDosePointEquivalentDepthTag() const { return "(300a,0089)"; }
    bool setBeamDosePointEquivalentDepth(float parameter);
    
    // BeamDosePointSSD (300a,008a) vr=FL, vm=1, type=3
    bool getBeamDosePointSSD(float& parameter) const;
    std::string getBeamDosePointSSDTag() const { return "(300a,008a)"; }
    bool setBeamDosePointSSD(float parameter);
    
    // BeamDoseSpecificationPoint (300a,0082) vr=DS, vm=3, type=3
    bool getBeamDoseSpecificationPoint(std::string& parameter) const;
    std::string getBeamDoseSpecificationPointTag() const { return "(300a,0082)"; }
    bool setBeamDoseSpecificationPoint(std::string parameter);
    
    // BeamMeterset (300a,0086) vr=DS, vm=1, type=3
    bool getBeamMeterset(std::string& parameter) const;
    std::string getBeamMetersetTag() const { return "(300a,0086)"; }
    bool setBeamMeterset(std::string parameter);
    
    // ReferencedBeamNumber (300c,0006) vr=IS, vm=1, type=1C
    bool getReferencedBeamNumber(std::string& parameter) const;
    std::string getReferencedBeamNumberTag() const { return "(300c,0006)"; }
    bool setReferencedBeamNumber(std::string parameter);
    
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface()  { }
    
    DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface(std::vector<DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface() {} 
    // BeamDose (300a,0084) vr=DS, vm=1, type=3
    bool getBeamDose(unsigned long idx, std::string& parameter) const;
    bool getBeamDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBeamDoseTag() const { return "(300a,0084)"; }
    bool setBeamDose(unsigned long idx, std::string parameter);
    
    // BeamDosePointDepth (300a,0088) vr=FL, vm=1, type=3
    bool getBeamDosePointDepth(unsigned long idx, float& parameter) const;
    bool getBeamDosePointDepth(DCMTree::TreePtr item, float& parameter) const;
    std::string getBeamDosePointDepthTag() const { return "(300a,0088)"; }
    bool setBeamDosePointDepth(unsigned long idx, float parameter);
    
    // BeamDosePointEquivalentDepth (300a,0089) vr=FL, vm=1, type=3
    bool getBeamDosePointEquivalentDepth(unsigned long idx, float& parameter) const;
    bool getBeamDosePointEquivalentDepth(DCMTree::TreePtr item, float& parameter) const;
    std::string getBeamDosePointEquivalentDepthTag() const { return "(300a,0089)"; }
    bool setBeamDosePointEquivalentDepth(unsigned long idx, float parameter);
    
    // BeamDosePointSSD (300a,008a) vr=FL, vm=1, type=3
    bool getBeamDosePointSSD(unsigned long idx, float& parameter) const;
    bool getBeamDosePointSSD(DCMTree::TreePtr item, float& parameter) const;
    std::string getBeamDosePointSSDTag() const { return "(300a,008a)"; }
    bool setBeamDosePointSSD(unsigned long idx, float parameter);
    
    // BeamDoseSpecificationPoint (300a,0082) vr=DS, vm=3, type=3
    bool getBeamDoseSpecificationPoint(unsigned long idx, std::string& parameter) const;
    bool getBeamDoseSpecificationPoint(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBeamDoseSpecificationPointTag() const { return "(300a,0082)"; }
    bool setBeamDoseSpecificationPoint(unsigned long idx, std::string parameter);
    
    // BeamMeterset (300a,0086) vr=DS, vm=1, type=3
    bool getBeamMeterset(unsigned long idx, std::string& parameter) const;
    bool getBeamMeterset(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBeamMetersetTag() const { return "(300a,0086)"; }
    bool setBeamMeterset(unsigned long idx, std::string parameter);
    
    // ReferencedBeamNumber (300c,0006) vr=IS, vm=1, type=1C
    bool getReferencedBeamNumber(unsigned long idx, std::string& parameter) const;
    bool getReferencedBeamNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedBeamNumberTag() const { return "(300c,0006)"; }
    bool setReferencedBeamNumber(unsigned long idx, std::string parameter);
     
    
    void setSequence(std::vector<DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item();
    }
    
    DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */