mlDcmDRTExposureSequenceInterface.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 __mlDcmDRTExposureSequenceInterface_H
#define __mlDcmDRTExposureSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTExposureSequenceInterface.h" //DRTExposureSequence
#include "mlDcmDRTApplicatorSequenceInRTImageModuleInterface.h" //DRTApplicatorSequenceInRTImageModule
#include "mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h" //DRTBeamLimitingDeviceSequenceInRTImageModule
#include "mlDcmDRTBlockSequenceInRTImageModuleInterface.h" //DRTBlockSequenceInRTImageModule
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTExposureSequenceInterface
{
  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; }
 
      
    // DiaphragmPosition (3002,0034) vr=DS, vm=4, type=3
    bool getDiaphragmPosition(std::string& parameter) const;
    std::string getDiaphragmPositionTag() const { return "(3002,0034)"; }
    bool setDiaphragmPosition(std::string parameter);
    
    // ExposureTime (0018,1150) vr=IS, vm=1, type=2C
    bool getExposureTime(std::string& parameter) const;
    std::string getExposureTimeTag() const { return "(0018,1150)"; }
    bool setExposureTime(std::string parameter);
    
    // FluenceDataScale (3002,0042) vr=DS, vm=1, type=3
    bool getFluenceDataScale(std::string& parameter) const;
    std::string getFluenceDataScaleTag() const { return "(3002,0042)"; }
    bool setFluenceDataScale(std::string parameter);
    
    // FluenceDataSource (3002,0041) vr=CS, vm=1, type=1
    bool getFluenceDataSource(std::string& parameter) const;
    std::string getFluenceDataSourceTag() const { return "(3002,0041)"; }
    bool setFluenceDataSource(std::string parameter);
    
    // KVP (0018,0060) vr=DS, vm=1, type=2C
    bool getKVP(std::string& parameter) const;
    std::string getKVPTag() const { return "(0018,0060)"; }
    bool setKVP(std::string parameter);
    
    // MetersetExposure (3002,0032) vr=DS, vm=1, type=2C
    bool getMetersetExposure(std::string& parameter) const;
    std::string getMetersetExposureTag() const { return "(3002,0032)"; }
    bool setMetersetExposure(std::string parameter);
    
    // NumberOfBlocks (300a,00f0) vr=IS, vm=1, type=1C
    bool getNumberOfBlocks(std::string& parameter) const;
    std::string getNumberOfBlocksTag() const { return "(300a,00f0)"; }
    bool setNumberOfBlocks(std::string parameter);
    
    // ReferencedFrameNumber (0008,1160) vr=IS, vm=1-n, type=1C
    bool getReferencedFrameNumber(std::string& parameter) const;
    std::string getReferencedFrameNumberTag() const { return "(0008,1160)"; }
    bool setReferencedFrameNumber(std::string parameter);
    
    // XRayTubeCurrent (0018,1151) vr=IS, vm=1, type=2C
    bool getXRayTubeCurrent(std::string& parameter) const;
    std::string getXRayTubeCurrentTag() const { return "(0018,1151)"; }
    bool setXRayTubeCurrent(std::string parameter);
    
    // ApplicatorSequence (300a,0107) vr=SQ, vm=1, type=3
    DcmDRTApplicatorSequenceInRTImageModuleInterface getApplicatorSequence() const;
    std::string getApplicatorSequenceTag() const { return std::string("(300a,0107)"); }
    void setApplicatorSequence(DcmDRTApplicatorSequenceInRTImageModuleInterface seq);
 
    // BeamLimitingDeviceSequence (300a,00b6) vr=SQ, vm=1, type=3
    DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface getBeamLimitingDeviceSequence() const;
    std::string getBeamLimitingDeviceSequenceTag() const { return std::string("(300a,00b6)"); }
    void setBeamLimitingDeviceSequence(DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface seq);
 
    // BlockSequence (300a,00f4) vr=SQ, vm=1, type=2C
    DcmDRTBlockSequenceInRTImageModuleInterface getBlockSequence() const;
    std::string getBlockSequenceTag() const { return std::string("(300a,00f4)"); }
    void setBlockSequence(DcmDRTBlockSequenceInRTImageModuleInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTExposureSequenceInterface()  { }
    
    DcmDRTExposureSequenceInterface(std::vector<DcmDRTExposureSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTExposureSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTExposureSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTExposureSequenceInterface() {} 
    // DiaphragmPosition (3002,0034) vr=DS, vm=4, type=3
    bool getDiaphragmPosition(unsigned long idx, std::string& parameter) const;
    bool getDiaphragmPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDiaphragmPositionTag() const { return "(3002,0034)"; }
    bool setDiaphragmPosition(unsigned long idx, std::string parameter);
    
    // ExposureTime (0018,1150) vr=IS, vm=1, type=2C
    bool getExposureTime(unsigned long idx, std::string& parameter) const;
    bool getExposureTime(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getExposureTimeTag() const { return "(0018,1150)"; }
    bool setExposureTime(unsigned long idx, std::string parameter);
    
    // FluenceDataScale (3002,0042) vr=DS, vm=1, type=3
    bool getFluenceDataScale(unsigned long idx, std::string& parameter) const;
    bool getFluenceDataScale(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFluenceDataScaleTag() const { return "(3002,0042)"; }
    bool setFluenceDataScale(unsigned long idx, std::string parameter);
    
    // FluenceDataSource (3002,0041) vr=CS, vm=1, type=1
    bool getFluenceDataSource(unsigned long idx, std::string& parameter) const;
    bool getFluenceDataSource(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFluenceDataSourceTag() const { return "(3002,0041)"; }
    bool setFluenceDataSource(unsigned long idx, std::string parameter);
    
    // KVP (0018,0060) vr=DS, vm=1, type=2C
    bool getKVP(unsigned long idx, std::string& parameter) const;
    bool getKVP(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getKVPTag() const { return "(0018,0060)"; }
    bool setKVP(unsigned long idx, std::string parameter);
    
    // MetersetExposure (3002,0032) vr=DS, vm=1, type=2C
    bool getMetersetExposure(unsigned long idx, std::string& parameter) const;
    bool getMetersetExposure(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getMetersetExposureTag() const { return "(3002,0032)"; }
    bool setMetersetExposure(unsigned long idx, std::string parameter);
    
    // NumberOfBlocks (300a,00f0) vr=IS, vm=1, type=1C
    bool getNumberOfBlocks(unsigned long idx, std::string& parameter) const;
    bool getNumberOfBlocks(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNumberOfBlocksTag() const { return "(300a,00f0)"; }
    bool setNumberOfBlocks(unsigned long idx, std::string parameter);
    
    // ReferencedFrameNumber (0008,1160) vr=IS, vm=1-n, type=1C
    bool getReferencedFrameNumber(unsigned long idx, std::string& parameter) const;
    bool getReferencedFrameNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedFrameNumberTag() const { return "(0008,1160)"; }
    bool setReferencedFrameNumber(unsigned long idx, std::string parameter);
    
    // XRayTubeCurrent (0018,1151) vr=IS, vm=1, type=2C
    bool getXRayTubeCurrent(unsigned long idx, std::string& parameter) const;
    bool getXRayTubeCurrent(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getXRayTubeCurrentTag() const { return "(0018,1151)"; }
    bool setXRayTubeCurrent(unsigned long idx, std::string parameter);
     
    // ApplicatorSequence (300a,0107) vr=SQ, vm=1, type=3
    DcmDRTApplicatorSequenceInRTImageModuleInterface getApplicatorSequence(unsigned long idx) const;
    std::string getApplicatorSequenceTag() const { return std::string("(300a,0107)"); }
    void setApplicatorSequence(DcmDRTApplicatorSequenceInRTImageModuleInterface seq, unsigned long idx);
 
    // BeamLimitingDeviceSequence (300a,00b6) vr=SQ, vm=1, type=3
    DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface getBeamLimitingDeviceSequence(unsigned long idx) const;
    std::string getBeamLimitingDeviceSequenceTag() const { return std::string("(300a,00b6)"); }
    void setBeamLimitingDeviceSequence(DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface seq, unsigned long idx);
 
    // BlockSequence (300a,00f4) vr=SQ, vm=1, type=2C
    DcmDRTBlockSequenceInRTImageModuleInterface getBlockSequence(unsigned long idx) const;
    std::string getBlockSequenceTag() const { return std::string("(300a,00f4)"); }
    void setBlockSequence(DcmDRTBlockSequenceInRTImageModuleInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTExposureSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTExposureSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTExposureSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTExposureSequenceInterface::Item();
    }
    
    DcmDRTExposureSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTExposureSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTExposureSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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