mlDcmDRTDVHSequenceInterface.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 __mlDcmDRTDVHSequenceInterface_H
#define __mlDcmDRTDVHSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTDVHSequenceInterface.h" //DRTDVHSequence
#include "mlDcmDRTDVHReferencedROISequenceInterface.h" //DRTDVHReferencedROISequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTDVHSequenceInterface
{
  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; }
 
      
    // DVHData (3004,0058) vr=DS, vm=2-2n, type=1
    bool getDVHData(std::string& parameter) const;
    std::string getDVHDataTag() const { return "(3004,0058)"; }
    bool setDVHData(std::string parameter);
    
    // DVHDoseScaling (3004,0052) vr=DS, vm=1, type=1
    bool getDVHDoseScaling(std::string& parameter) const;
    std::string getDVHDoseScalingTag() const { return "(3004,0052)"; }
    bool setDVHDoseScaling(std::string parameter);
    
    // DVHMaximumDose (3004,0072) vr=DS, vm=1, type=3
    bool getDVHMaximumDose(std::string& parameter) const;
    std::string getDVHMaximumDoseTag() const { return "(3004,0072)"; }
    bool setDVHMaximumDose(std::string parameter);
    
    // DVHMeanDose (3004,0074) vr=DS, vm=1, type=3
    bool getDVHMeanDose(std::string& parameter) const;
    std::string getDVHMeanDoseTag() const { return "(3004,0074)"; }
    bool setDVHMeanDose(std::string parameter);
    
    // DVHMinimumDose (3004,0070) vr=DS, vm=1, type=3
    bool getDVHMinimumDose(std::string& parameter) const;
    std::string getDVHMinimumDoseTag() const { return "(3004,0070)"; }
    bool setDVHMinimumDose(std::string parameter);
    
    // DVHNumberOfBins (3004,0056) vr=IS, vm=1, type=1
    bool getDVHNumberOfBins(std::string& parameter) const;
    std::string getDVHNumberOfBinsTag() const { return "(3004,0056)"; }
    bool setDVHNumberOfBins(std::string parameter);
    
    // DVHType (3004,0001) vr=CS, vm=1, type=1
    bool getDVHType(std::string& parameter) const;
    std::string getDVHTypeTag() const { return "(3004,0001)"; }
    bool setDVHType(std::string parameter);
    
    // DVHVolumeUnits (3004,0054) vr=CS, vm=1, type=1
    bool getDVHVolumeUnits(std::string& parameter) const;
    std::string getDVHVolumeUnitsTag() const { return "(3004,0054)"; }
    bool setDVHVolumeUnits(std::string parameter);
    
    // DoseType (3004,0004) vr=CS, vm=1, type=1
    bool getDoseType(std::string& parameter) const;
    std::string getDoseTypeTag() const { return "(3004,0004)"; }
    bool setDoseType(std::string parameter);
    
    // DoseUnits (3004,0002) vr=CS, vm=1, type=1
    bool getDoseUnits(std::string& parameter) const;
    std::string getDoseUnitsTag() const { return "(3004,0002)"; }
    bool setDoseUnits(std::string parameter);
    
    // DVHReferencedROISequence (3004,0060) vr=SQ, vm=1, type=1
    DcmDRTDVHReferencedROISequenceInterface getDVHReferencedROISequence() const;
    std::string getDVHReferencedROISequenceTag() const { return std::string("(3004,0060)"); }
    void setDVHReferencedROISequence(DcmDRTDVHReferencedROISequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTDVHSequenceInterface()  { }
    
    DcmDRTDVHSequenceInterface(std::vector<DcmDRTDVHSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTDVHSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTDVHSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTDVHSequenceInterface() {} 
    // DVHData (3004,0058) vr=DS, vm=2-2n, type=1
    bool getDVHData(unsigned long idx, std::string& parameter) const;
    bool getDVHData(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDVHDataTag() const { return "(3004,0058)"; }
    bool setDVHData(unsigned long idx, std::string parameter);
    
    // DVHDoseScaling (3004,0052) vr=DS, vm=1, type=1
    bool getDVHDoseScaling(unsigned long idx, std::string& parameter) const;
    bool getDVHDoseScaling(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDVHDoseScalingTag() const { return "(3004,0052)"; }
    bool setDVHDoseScaling(unsigned long idx, std::string parameter);
    
    // DVHMaximumDose (3004,0072) vr=DS, vm=1, type=3
    bool getDVHMaximumDose(unsigned long idx, std::string& parameter) const;
    bool getDVHMaximumDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDVHMaximumDoseTag() const { return "(3004,0072)"; }
    bool setDVHMaximumDose(unsigned long idx, std::string parameter);
    
    // DVHMeanDose (3004,0074) vr=DS, vm=1, type=3
    bool getDVHMeanDose(unsigned long idx, std::string& parameter) const;
    bool getDVHMeanDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDVHMeanDoseTag() const { return "(3004,0074)"; }
    bool setDVHMeanDose(unsigned long idx, std::string parameter);
    
    // DVHMinimumDose (3004,0070) vr=DS, vm=1, type=3
    bool getDVHMinimumDose(unsigned long idx, std::string& parameter) const;
    bool getDVHMinimumDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDVHMinimumDoseTag() const { return "(3004,0070)"; }
    bool setDVHMinimumDose(unsigned long idx, std::string parameter);
    
    // DVHNumberOfBins (3004,0056) vr=IS, vm=1, type=1
    bool getDVHNumberOfBins(unsigned long idx, std::string& parameter) const;
    bool getDVHNumberOfBins(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDVHNumberOfBinsTag() const { return "(3004,0056)"; }
    bool setDVHNumberOfBins(unsigned long idx, std::string parameter);
    
    // DVHType (3004,0001) vr=CS, vm=1, type=1
    bool getDVHType(unsigned long idx, std::string& parameter) const;
    bool getDVHType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDVHTypeTag() const { return "(3004,0001)"; }
    bool setDVHType(unsigned long idx, std::string parameter);
    
    // DVHVolumeUnits (3004,0054) vr=CS, vm=1, type=1
    bool getDVHVolumeUnits(unsigned long idx, std::string& parameter) const;
    bool getDVHVolumeUnits(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDVHVolumeUnitsTag() const { return "(3004,0054)"; }
    bool setDVHVolumeUnits(unsigned long idx, std::string parameter);
    
    // DoseType (3004,0004) vr=CS, vm=1, type=1
    bool getDoseType(unsigned long idx, std::string& parameter) const;
    bool getDoseType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDoseTypeTag() const { return "(3004,0004)"; }
    bool setDoseType(unsigned long idx, std::string parameter);
    
    // DoseUnits (3004,0002) vr=CS, vm=1, type=1
    bool getDoseUnits(unsigned long idx, std::string& parameter) const;
    bool getDoseUnits(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDoseUnitsTag() const { return "(3004,0002)"; }
    bool setDoseUnits(unsigned long idx, std::string parameter);
     
    // DVHReferencedROISequence (3004,0060) vr=SQ, vm=1, type=1
    DcmDRTDVHReferencedROISequenceInterface getDVHReferencedROISequence(unsigned long idx) const;
    std::string getDVHReferencedROISequenceTag() const { return std::string("(3004,0060)"); }
    void setDVHReferencedROISequence(DcmDRTDVHReferencedROISequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTDVHSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTDVHSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTDVHSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTDVHSequenceInterface::Item();
    }
    
    DcmDRTDVHSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTDVHSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTDVHSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTDVHSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTDVHSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTDVHSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTDVHSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTDVHSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */