mlDcmDRTIonRangeCompensatorSequenceInterface.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 __mlDcmDRTIonRangeCompensatorSequenceInterface_H
#define __mlDcmDRTIonRangeCompensatorSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTIonRangeCompensatorSequenceInterface.h" //DRTIonRangeCompensatorSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTIonRangeCompensatorSequenceInterface
{
  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);
    
    // CompensatorColumnOffset (300a,02e5) vr=FL, vm=1, type=1C
    bool getCompensatorColumnOffset(float& parameter) const;
    std::string getCompensatorColumnOffsetTag() const { return "(300a,02e5)"; }
    bool setCompensatorColumnOffset(float parameter);
    
    // CompensatorColumns (300a,00e8) vr=IS, vm=1, type=1
    bool getCompensatorColumns(std::string& parameter) const;
    std::string getCompensatorColumnsTag() const { return "(300a,00e8)"; }
    bool setCompensatorColumns(std::string parameter);
    
    // CompensatorDivergence (300a,02e0) vr=CS, vm=1, type=1
    bool getCompensatorDivergence(std::string& parameter) const;
    std::string getCompensatorDivergenceTag() const { return "(300a,02e0)"; }
    bool setCompensatorDivergence(std::string parameter);
    
    // CompensatorID (300a,00e5) vr=SH, vm=1, type=3
    bool getCompensatorID(std::string& parameter) const;
    std::string getCompensatorIDTag() const { return "(300a,00e5)"; }
    bool setCompensatorID(std::string parameter);
    
    // CompensatorMillingToolDiameter (300a,02e8) vr=FL, vm=1, type=3
    bool getCompensatorMillingToolDiameter(float& parameter) const;
    std::string getCompensatorMillingToolDiameterTag() const { return "(300a,02e8)"; }
    bool setCompensatorMillingToolDiameter(float parameter);
    
    // CompensatorMountingPosition (300a,02e1) vr=CS, vm=1, type=1
    bool getCompensatorMountingPosition(std::string& parameter) const;
    std::string getCompensatorMountingPositionTag() const { return "(300a,02e1)"; }
    bool setCompensatorMountingPosition(std::string parameter);
    
    // CompensatorNumber (300a,00e4) vr=IS, vm=1, type=1
    bool getCompensatorNumber(std::string& parameter) const;
    std::string getCompensatorNumberTag() const { return "(300a,00e4)"; }
    bool setCompensatorNumber(std::string parameter);
    
    // CompensatorPixelSpacing (300a,00e9) vr=DS, vm=2, type=1
    bool getCompensatorPixelSpacing(std::string& parameter) const;
    std::string getCompensatorPixelSpacingTag() const { return "(300a,00e9)"; }
    bool setCompensatorPixelSpacing(std::string parameter);
    
    // CompensatorPosition (300a,00ea) vr=DS, vm=2, type=1
    bool getCompensatorPosition(std::string& parameter) const;
    std::string getCompensatorPositionTag() const { return "(300a,00ea)"; }
    bool setCompensatorPosition(std::string parameter);
    
    // CompensatorRelativeStoppingPowerRatio (300a,02e7) vr=FL, vm=1, type=3
    bool getCompensatorRelativeStoppingPowerRatio(float& parameter) const;
    std::string getCompensatorRelativeStoppingPowerRatioTag() const { return "(300a,02e7)"; }
    bool setCompensatorRelativeStoppingPowerRatio(float parameter);
    
    // CompensatorRows (300a,00e7) vr=IS, vm=1, type=1
    bool getCompensatorRows(std::string& parameter) const;
    std::string getCompensatorRowsTag() const { return "(300a,00e7)"; }
    bool setCompensatorRows(std::string parameter);
    
    // CompensatorThicknessData (300a,00ec) vr=DS, vm=1-n, type=1
    bool getCompensatorThicknessData(std::string& parameter) const;
    std::string getCompensatorThicknessDataTag() const { return "(300a,00ec)"; }
    bool setCompensatorThicknessData(std::string parameter);
    
    // IsocenterToCompensatorDistances (300a,02e6) vr=FL, vm=1-n, type=1C
    bool getIsocenterToCompensatorDistances(float& parameter) const;
    std::string getIsocenterToCompensatorDistancesTag() const { return "(300a,02e6)"; }
    bool setIsocenterToCompensatorDistances(float parameter);
    
    // IsocenterToCompensatorTrayDistance (300a,02e4) vr=FL, vm=1, type=1C
    bool getIsocenterToCompensatorTrayDistance(float& parameter) const;
    std::string getIsocenterToCompensatorTrayDistanceTag() const { return "(300a,02e4)"; }
    bool setIsocenterToCompensatorTrayDistance(float parameter);
    
    // MaterialID (300a,00e1) vr=SH, vm=1, type=2
    bool getMaterialID(std::string& parameter) const;
    std::string getMaterialIDTag() const { return "(300a,00e1)"; }
    bool setMaterialID(std::string parameter);
    
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTIonRangeCompensatorSequenceInterface()  { }
    
    DcmDRTIonRangeCompensatorSequenceInterface(std::vector<DcmDRTIonRangeCompensatorSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTIonRangeCompensatorSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTIonRangeCompensatorSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTIonRangeCompensatorSequenceInterface() {} 
    // 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);
    
    // CompensatorColumnOffset (300a,02e5) vr=FL, vm=1, type=1C
    bool getCompensatorColumnOffset(unsigned long idx, float& parameter) const;
    bool getCompensatorColumnOffset(DCMTree::TreePtr item, float& parameter) const;
    std::string getCompensatorColumnOffsetTag() const { return "(300a,02e5)"; }
    bool setCompensatorColumnOffset(unsigned long idx, float parameter);
    
    // CompensatorColumns (300a,00e8) vr=IS, vm=1, type=1
    bool getCompensatorColumns(unsigned long idx, std::string& parameter) const;
    bool getCompensatorColumns(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCompensatorColumnsTag() const { return "(300a,00e8)"; }
    bool setCompensatorColumns(unsigned long idx, std::string parameter);
    
    // CompensatorDivergence (300a,02e0) vr=CS, vm=1, type=1
    bool getCompensatorDivergence(unsigned long idx, std::string& parameter) const;
    bool getCompensatorDivergence(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCompensatorDivergenceTag() const { return "(300a,02e0)"; }
    bool setCompensatorDivergence(unsigned long idx, std::string parameter);
    
    // CompensatorID (300a,00e5) vr=SH, vm=1, type=3
    bool getCompensatorID(unsigned long idx, std::string& parameter) const;
    bool getCompensatorID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCompensatorIDTag() const { return "(300a,00e5)"; }
    bool setCompensatorID(unsigned long idx, std::string parameter);
    
    // CompensatorMillingToolDiameter (300a,02e8) vr=FL, vm=1, type=3
    bool getCompensatorMillingToolDiameter(unsigned long idx, float& parameter) const;
    bool getCompensatorMillingToolDiameter(DCMTree::TreePtr item, float& parameter) const;
    std::string getCompensatorMillingToolDiameterTag() const { return "(300a,02e8)"; }
    bool setCompensatorMillingToolDiameter(unsigned long idx, float parameter);
    
    // CompensatorMountingPosition (300a,02e1) vr=CS, vm=1, type=1
    bool getCompensatorMountingPosition(unsigned long idx, std::string& parameter) const;
    bool getCompensatorMountingPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCompensatorMountingPositionTag() const { return "(300a,02e1)"; }
    bool setCompensatorMountingPosition(unsigned long idx, std::string parameter);
    
    // CompensatorNumber (300a,00e4) vr=IS, vm=1, type=1
    bool getCompensatorNumber(unsigned long idx, std::string& parameter) const;
    bool getCompensatorNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCompensatorNumberTag() const { return "(300a,00e4)"; }
    bool setCompensatorNumber(unsigned long idx, std::string parameter);
    
    // CompensatorPixelSpacing (300a,00e9) vr=DS, vm=2, type=1
    bool getCompensatorPixelSpacing(unsigned long idx, std::string& parameter) const;
    bool getCompensatorPixelSpacing(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCompensatorPixelSpacingTag() const { return "(300a,00e9)"; }
    bool setCompensatorPixelSpacing(unsigned long idx, std::string parameter);
    
    // CompensatorPosition (300a,00ea) vr=DS, vm=2, type=1
    bool getCompensatorPosition(unsigned long idx, std::string& parameter) const;
    bool getCompensatorPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCompensatorPositionTag() const { return "(300a,00ea)"; }
    bool setCompensatorPosition(unsigned long idx, std::string parameter);
    
    // CompensatorRelativeStoppingPowerRatio (300a,02e7) vr=FL, vm=1, type=3
    bool getCompensatorRelativeStoppingPowerRatio(unsigned long idx, float& parameter) const;
    bool getCompensatorRelativeStoppingPowerRatio(DCMTree::TreePtr item, float& parameter) const;
    std::string getCompensatorRelativeStoppingPowerRatioTag() const { return "(300a,02e7)"; }
    bool setCompensatorRelativeStoppingPowerRatio(unsigned long idx, float parameter);
    
    // CompensatorRows (300a,00e7) vr=IS, vm=1, type=1
    bool getCompensatorRows(unsigned long idx, std::string& parameter) const;
    bool getCompensatorRows(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCompensatorRowsTag() const { return "(300a,00e7)"; }
    bool setCompensatorRows(unsigned long idx, std::string parameter);
    
    // CompensatorThicknessData (300a,00ec) vr=DS, vm=1-n, type=1
    bool getCompensatorThicknessData(unsigned long idx, std::string& parameter) const;
    bool getCompensatorThicknessData(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCompensatorThicknessDataTag() const { return "(300a,00ec)"; }
    bool setCompensatorThicknessData(unsigned long idx, std::string parameter);
    
    // IsocenterToCompensatorDistances (300a,02e6) vr=FL, vm=1-n, type=1C
    bool getIsocenterToCompensatorDistances(unsigned long idx, float& parameter) const;
    bool getIsocenterToCompensatorDistances(DCMTree::TreePtr item, float& parameter) const;
    std::string getIsocenterToCompensatorDistancesTag() const { return "(300a,02e6)"; }
    bool setIsocenterToCompensatorDistances(unsigned long idx, float parameter);
    
    // IsocenterToCompensatorTrayDistance (300a,02e4) vr=FL, vm=1, type=1C
    bool getIsocenterToCompensatorTrayDistance(unsigned long idx, float& parameter) const;
    bool getIsocenterToCompensatorTrayDistance(DCMTree::TreePtr item, float& parameter) const;
    std::string getIsocenterToCompensatorTrayDistanceTag() const { return "(300a,02e4)"; }
    bool setIsocenterToCompensatorTrayDistance(unsigned long idx, float parameter);
    
    // MaterialID (300a,00e1) vr=SH, vm=1, type=2
    bool getMaterialID(unsigned long idx, std::string& parameter) const;
    bool getMaterialID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getMaterialIDTag() const { return "(300a,00e1)"; }
    bool setMaterialID(unsigned long idx, std::string parameter);
     
    
    void setSequence(std::vector<DcmDRTIonRangeCompensatorSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTIonRangeCompensatorSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTIonRangeCompensatorSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTIonRangeCompensatorSequenceInterface::Item();
    }
    
    DcmDRTIonRangeCompensatorSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTIonRangeCompensatorSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTIonRangeCompensatorSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTIonRangeCompensatorSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTIonRangeCompensatorSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTIonRangeCompensatorSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTIonRangeCompensatorSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTIonRangeCompensatorSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */