mlDcmDRTIonBlockSequenceInterface.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 __mlDcmDRTIonBlockSequenceInterface_H
#define __mlDcmDRTIonBlockSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTIonBlockSequenceInterface.h" //DRTIonBlockSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTIonBlockSequenceInterface
{
  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);
    
    // BlockData (300a,0106) vr=DS, vm=2-2n, type=1
    bool getBlockData(std::string& parameter) const;
    std::string getBlockDataTag() const { return "(300a,0106)"; }
    bool setBlockData(std::string parameter);
    
    // BlockDivergence (300a,00fa) vr=CS, vm=1, type=1
    bool getBlockDivergence(std::string& parameter) const;
    std::string getBlockDivergenceTag() const { return "(300a,00fa)"; }
    bool setBlockDivergence(std::string parameter);
    
    // BlockMountingPosition (300a,00fb) vr=CS, vm=1, type=1
    bool getBlockMountingPosition(std::string& parameter) const;
    std::string getBlockMountingPositionTag() const { return "(300a,00fb)"; }
    bool setBlockMountingPosition(std::string parameter);
    
    // BlockName (300a,00fe) vr=LO, vm=1, type=3
    bool getBlockName(std::string& parameter) const;
    std::string getBlockNameTag() const { return "(300a,00fe)"; }
    bool setBlockName(std::string parameter);
    
    // BlockNumber (300a,00fc) vr=IS, vm=1, type=1
    bool getBlockNumber(std::string& parameter) const;
    std::string getBlockNumberTag() const { return "(300a,00fc)"; }
    bool setBlockNumber(std::string parameter);
    
    // BlockNumberOfPoints (300a,0104) vr=IS, vm=1, type=1
    bool getBlockNumberOfPoints(std::string& parameter) const;
    std::string getBlockNumberOfPointsTag() const { return "(300a,0104)"; }
    bool setBlockNumberOfPoints(std::string parameter);
    
    // BlockThickness (300a,0100) vr=DS, vm=1, type=1
    bool getBlockThickness(std::string& parameter) const;
    std::string getBlockThicknessTag() const { return "(300a,0100)"; }
    bool setBlockThickness(std::string parameter);
    
    // BlockTrayID (300a,00f5) vr=SH, vm=1, type=3
    bool getBlockTrayID(std::string& parameter) const;
    std::string getBlockTrayIDTag() const { return "(300a,00f5)"; }
    bool setBlockTrayID(std::string parameter);
    
    // BlockType (300a,00f8) vr=CS, vm=1, type=1
    bool getBlockType(std::string& parameter) const;
    std::string getBlockTypeTag() const { return "(300a,00f8)"; }
    bool setBlockType(std::string parameter);
    
    // IsocenterToBlockTrayDistance (300a,00f7) vr=FL, vm=1, type=1
    bool getIsocenterToBlockTrayDistance(float& parameter) const;
    std::string getIsocenterToBlockTrayDistanceTag() const { return "(300a,00f7)"; }
    bool setIsocenterToBlockTrayDistance(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;
      
    };
 
    DcmDRTIonBlockSequenceInterface()  { }
    
    DcmDRTIonBlockSequenceInterface(std::vector<DcmDRTIonBlockSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTIonBlockSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTIonBlockSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTIonBlockSequenceInterface() {} 
    // 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);
    
    // BlockData (300a,0106) vr=DS, vm=2-2n, type=1
    bool getBlockData(unsigned long idx, std::string& parameter) const;
    bool getBlockData(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBlockDataTag() const { return "(300a,0106)"; }
    bool setBlockData(unsigned long idx, std::string parameter);
    
    // BlockDivergence (300a,00fa) vr=CS, vm=1, type=1
    bool getBlockDivergence(unsigned long idx, std::string& parameter) const;
    bool getBlockDivergence(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBlockDivergenceTag() const { return "(300a,00fa)"; }
    bool setBlockDivergence(unsigned long idx, std::string parameter);
    
    // BlockMountingPosition (300a,00fb) vr=CS, vm=1, type=1
    bool getBlockMountingPosition(unsigned long idx, std::string& parameter) const;
    bool getBlockMountingPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBlockMountingPositionTag() const { return "(300a,00fb)"; }
    bool setBlockMountingPosition(unsigned long idx, std::string parameter);
    
    // BlockName (300a,00fe) vr=LO, vm=1, type=3
    bool getBlockName(unsigned long idx, std::string& parameter) const;
    bool getBlockName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBlockNameTag() const { return "(300a,00fe)"; }
    bool setBlockName(unsigned long idx, std::string parameter);
    
    // BlockNumber (300a,00fc) vr=IS, vm=1, type=1
    bool getBlockNumber(unsigned long idx, std::string& parameter) const;
    bool getBlockNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBlockNumberTag() const { return "(300a,00fc)"; }
    bool setBlockNumber(unsigned long idx, std::string parameter);
    
    // BlockNumberOfPoints (300a,0104) vr=IS, vm=1, type=1
    bool getBlockNumberOfPoints(unsigned long idx, std::string& parameter) const;
    bool getBlockNumberOfPoints(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBlockNumberOfPointsTag() const { return "(300a,0104)"; }
    bool setBlockNumberOfPoints(unsigned long idx, std::string parameter);
    
    // BlockThickness (300a,0100) vr=DS, vm=1, type=1
    bool getBlockThickness(unsigned long idx, std::string& parameter) const;
    bool getBlockThickness(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBlockThicknessTag() const { return "(300a,0100)"; }
    bool setBlockThickness(unsigned long idx, std::string parameter);
    
    // BlockTrayID (300a,00f5) vr=SH, vm=1, type=3
    bool getBlockTrayID(unsigned long idx, std::string& parameter) const;
    bool getBlockTrayID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBlockTrayIDTag() const { return "(300a,00f5)"; }
    bool setBlockTrayID(unsigned long idx, std::string parameter);
    
    // BlockType (300a,00f8) vr=CS, vm=1, type=1
    bool getBlockType(unsigned long idx, std::string& parameter) const;
    bool getBlockType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getBlockTypeTag() const { return "(300a,00f8)"; }
    bool setBlockType(unsigned long idx, std::string parameter);
    
    // IsocenterToBlockTrayDistance (300a,00f7) vr=FL, vm=1, type=1
    bool getIsocenterToBlockTrayDistance(unsigned long idx, float& parameter) const;
    bool getIsocenterToBlockTrayDistance(DCMTree::TreePtr item, float& parameter) const;
    std::string getIsocenterToBlockTrayDistanceTag() const { return "(300a,00f7)"; }
    bool setIsocenterToBlockTrayDistance(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<DcmDRTIonBlockSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTIonBlockSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTIonBlockSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTIonBlockSequenceInterface::Item();
    }
    
    DcmDRTIonBlockSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTIonBlockSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTIonBlockSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTIonBlockSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTIonBlockSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTIonBlockSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTIonBlockSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTIonBlockSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */