mlDcmDRTBrachyControlPointSequenceInterface.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 __mlDcmDRTBrachyControlPointSequenceInterface_H
#define __mlDcmDRTBrachyControlPointSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTBrachyControlPointSequenceInterface.h" //DRTBrachyControlPointSequence
#include "mlDcmDRTBrachyReferencedDoseReferenceSequenceInterface.h" //DRTBrachyReferencedDoseReferenceSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTBrachyControlPointSequenceInterface
{
  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; }
 
      
    // ControlPoint3DPosition (300a,02d4) vr=DS, vm=3, type=3
    bool getControlPoint3DPosition(std::string& parameter) const;
    std::string getControlPoint3DPositionTag() const { return "(300a,02d4)"; }
    bool setControlPoint3DPosition(std::string parameter);
    
    // ControlPointIndex (300a,0112) vr=IS, vm=1, type=1
    bool getControlPointIndex(std::string& parameter) const;
    std::string getControlPointIndexTag() const { return "(300a,0112)"; }
    bool setControlPointIndex(std::string parameter);
    
    // ControlPointRelativePosition (300a,02d2) vr=DS, vm=1, type=1
    bool getControlPointRelativePosition(std::string& parameter) const;
    std::string getControlPointRelativePositionTag() const { return "(300a,02d2)"; }
    bool setControlPointRelativePosition(std::string parameter);
    
    // CumulativeTimeWeight (300a,02d6) vr=DS, vm=1, type=2
    bool getCumulativeTimeWeight(std::string& parameter) const;
    std::string getCumulativeTimeWeightTag() const { return "(300a,02d6)"; }
    bool setCumulativeTimeWeight(std::string parameter);
    
    // BrachyReferencedDoseReferenceSequence (300c,0055) vr=SQ, vm=1, type=3
    DcmDRTBrachyReferencedDoseReferenceSequenceInterface getBrachyReferencedDoseReferenceSequence() const;
    std::string getBrachyReferencedDoseReferenceSequenceTag() const { return std::string("(300c,0055)"); }
    void setBrachyReferencedDoseReferenceSequence(DcmDRTBrachyReferencedDoseReferenceSequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTBrachyControlPointSequenceInterface()  { }
    
    DcmDRTBrachyControlPointSequenceInterface(std::vector<DcmDRTBrachyControlPointSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTBrachyControlPointSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTBrachyControlPointSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTBrachyControlPointSequenceInterface() {} 
    // ControlPoint3DPosition (300a,02d4) vr=DS, vm=3, type=3
    bool getControlPoint3DPosition(unsigned long idx, std::string& parameter) const;
    bool getControlPoint3DPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getControlPoint3DPositionTag() const { return "(300a,02d4)"; }
    bool setControlPoint3DPosition(unsigned long idx, std::string parameter);
    
    // ControlPointIndex (300a,0112) vr=IS, vm=1, type=1
    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);
    
    // ControlPointRelativePosition (300a,02d2) vr=DS, vm=1, type=1
    bool getControlPointRelativePosition(unsigned long idx, std::string& parameter) const;
    bool getControlPointRelativePosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getControlPointRelativePositionTag() const { return "(300a,02d2)"; }
    bool setControlPointRelativePosition(unsigned long idx, std::string parameter);
    
    // CumulativeTimeWeight (300a,02d6) vr=DS, vm=1, type=2
    bool getCumulativeTimeWeight(unsigned long idx, std::string& parameter) const;
    bool getCumulativeTimeWeight(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCumulativeTimeWeightTag() const { return "(300a,02d6)"; }
    bool setCumulativeTimeWeight(unsigned long idx, std::string parameter);
     
    // BrachyReferencedDoseReferenceSequence (300c,0055) vr=SQ, vm=1, type=3
    DcmDRTBrachyReferencedDoseReferenceSequenceInterface getBrachyReferencedDoseReferenceSequence(unsigned long idx) const;
    std::string getBrachyReferencedDoseReferenceSequenceTag() const { return std::string("(300c,0055)"); }
    void setBrachyReferencedDoseReferenceSequence(DcmDRTBrachyReferencedDoseReferenceSequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTBrachyControlPointSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTBrachyControlPointSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTBrachyControlPointSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTBrachyControlPointSequenceInterface::Item();
    }
    
    DcmDRTBrachyControlPointSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTBrachyControlPointSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTBrachyControlPointSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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