mlDcmDRTRangeModulatorSequenceInterface.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 __mlDcmDRTRangeModulatorSequenceInterface_H
#define __mlDcmDRTRangeModulatorSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTRangeModulatorSequenceInterface.h" //DRTRangeModulatorSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTRangeModulatorSequenceInterface
{
  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; }
 
      
    // AccessoryCode (300a,00f9) vr=LO, vm=1, type=3
    bool getAccessoryCode(std::string& parameter) const;
    std::string getAccessoryCodeTag() const { return "(300a,00f9)"; }
    bool setAccessoryCode(std::string parameter);
    
    // BeamCurrentModulationID (300a,034c) vr=SH, vm=1, type=1C
    bool getBeamCurrentModulationID(std::string& parameter) const;
    std::string getBeamCurrentModulationIDTag() const { return "(300a,034c)"; }
    bool setBeamCurrentModulationID(std::string parameter);
    
    // RangeModulatorDescription (300a,034a) vr=LO, vm=1, type=3
    bool getRangeModulatorDescription(std::string& parameter) const;
    std::string getRangeModulatorDescriptionTag() const { return "(300a,034a)"; }
    bool setRangeModulatorDescription(std::string parameter);
    
    // RangeModulatorID (300a,0346) vr=SH, vm=1, type=1
    bool getRangeModulatorID(std::string& parameter) const;
    std::string getRangeModulatorIDTag() const { return "(300a,0346)"; }
    bool setRangeModulatorID(std::string parameter);
    
    // RangeModulatorNumber (300a,0344) vr=IS, vm=1, type=1
    bool getRangeModulatorNumber(std::string& parameter) const;
    std::string getRangeModulatorNumberTag() const { return "(300a,0344)"; }
    bool setRangeModulatorNumber(std::string parameter);
    
    // RangeModulatorType (300a,0348) vr=CS, vm=1, type=1
    bool getRangeModulatorType(std::string& parameter) const;
    std::string getRangeModulatorTypeTag() const { return "(300a,0348)"; }
    bool setRangeModulatorType(std::string parameter);
    
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTRangeModulatorSequenceInterface()  { }
    
    DcmDRTRangeModulatorSequenceInterface(std::vector<DcmDRTRangeModulatorSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTRangeModulatorSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTRangeModulatorSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTRangeModulatorSequenceInterface() {} 
    // AccessoryCode (300a,00f9) vr=LO, vm=1, type=3
    bool getAccessoryCode(unsigned long idx, std::string& parameter) const;
    bool getAccessoryCode(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getAccessoryCodeTag() const { return "(300a,00f9)"; }
    bool setAccessoryCode(unsigned long idx, std::string parameter);
    
    // BeamCurrentModulationID (300a,034c) vr=SH, vm=1, type=1C
    bool getBeamCurrentModulationID(unsigned long idx, std::string& parameter) const;
    bool getBeamCurrentModulationID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBeamCurrentModulationIDTag() const { return "(300a,034c)"; }
    bool setBeamCurrentModulationID(unsigned long idx, std::string parameter);
    
    // RangeModulatorDescription (300a,034a) vr=LO, vm=1, type=3
    bool getRangeModulatorDescription(unsigned long idx, std::string& parameter) const;
    bool getRangeModulatorDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRangeModulatorDescriptionTag() const { return "(300a,034a)"; }
    bool setRangeModulatorDescription(unsigned long idx, std::string parameter);
    
    // RangeModulatorID (300a,0346) vr=SH, vm=1, type=1
    bool getRangeModulatorID(unsigned long idx, std::string& parameter) const;
    bool getRangeModulatorID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRangeModulatorIDTag() const { return "(300a,0346)"; }
    bool setRangeModulatorID(unsigned long idx, std::string parameter);
    
    // RangeModulatorNumber (300a,0344) vr=IS, vm=1, type=1
    bool getRangeModulatorNumber(unsigned long idx, std::string& parameter) const;
    bool getRangeModulatorNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRangeModulatorNumberTag() const { return "(300a,0344)"; }
    bool setRangeModulatorNumber(unsigned long idx, std::string parameter);
    
    // RangeModulatorType (300a,0348) vr=CS, vm=1, type=1
    bool getRangeModulatorType(unsigned long idx, std::string& parameter) const;
    bool getRangeModulatorType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRangeModulatorTypeTag() const { return "(300a,0348)"; }
    bool setRangeModulatorType(unsigned long idx, std::string parameter);
     
    
    void setSequence(std::vector<DcmDRTRangeModulatorSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTRangeModulatorSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTRangeModulatorSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTRangeModulatorSequenceInterface::Item();
    }
    
    DcmDRTRangeModulatorSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTRangeModulatorSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTRangeModulatorSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTRangeModulatorSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTRangeModulatorSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTRangeModulatorSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTRangeModulatorSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTRangeModulatorSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */