mlDcmDRTPlannedVerificationImageSequenceInterface.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 __mlDcmDRTPlannedVerificationImageSequenceInterface_H
#define __mlDcmDRTPlannedVerificationImageSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTPlannedVerificationImageSequenceInterface.h" //DRTPlannedVerificationImageSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTPlannedVerificationImageSequenceInterface
{
  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; }
 
      
    // EndCumulativeMetersetWeight (300c,0009) vr=DS, vm=1, type=3
    bool getEndCumulativeMetersetWeight(std::string& parameter) const;
    std::string getEndCumulativeMetersetWeightTag() const { return "(300c,0009)"; }
    bool setEndCumulativeMetersetWeight(std::string parameter);
    
    // ImagingDeviceSpecificAcquisitionParameters (300a,00cc) vr=LO, vm=1-n, type=3
    bool getImagingDeviceSpecificAcquisitionParameters(std::string& parameter) const;
    std::string getImagingDeviceSpecificAcquisitionParametersTag() const { return "(300a,00cc)"; }
    bool setImagingDeviceSpecificAcquisitionParameters(std::string parameter);
    
    // MetersetExposure (3002,0032) vr=DS, vm=1, type=3
    bool getMetersetExposure(std::string& parameter) const;
    std::string getMetersetExposureTag() const { return "(3002,0032)"; }
    bool setMetersetExposure(std::string parameter);
    
    // RTImageOrientation (3002,0010) vr=DS, vm=6, type=3
    bool getRTImageOrientation(std::string& parameter) const;
    std::string getRTImageOrientationTag() const { return "(3002,0010)"; }
    bool setRTImageOrientation(std::string parameter);
    
    // RTImagePlane (3002,000c) vr=CS, vm=1, type=3
    bool getRTImagePlane(std::string& parameter) const;
    std::string getRTImagePlaneTag() const { return "(3002,000c)"; }
    bool setRTImagePlane(std::string parameter);
    
    // RTImagePosition (3002,0012) vr=DS, vm=2, type=3
    bool getRTImagePosition(std::string& parameter) const;
    std::string getRTImagePositionTag() const { return "(3002,0012)"; }
    bool setRTImagePosition(std::string parameter);
    
    // RTImageSID (3002,0026) vr=DS, vm=1, type=3
    bool getRTImageSID(std::string& parameter) const;
    std::string getRTImageSIDTag() const { return "(3002,0026)"; }
    bool setRTImageSID(std::string parameter);
    
    // ReferencedReferenceImageNumber (300c,0007) vr=IS, vm=1, type=3
    bool getReferencedReferenceImageNumber(std::string& parameter) const;
    std::string getReferencedReferenceImageNumberTag() const { return "(300c,0007)"; }
    bool setReferencedReferenceImageNumber(std::string parameter);
    
    // StartCumulativeMetersetWeight (300c,0008) vr=DS, vm=1, type=3
    bool getStartCumulativeMetersetWeight(std::string& parameter) const;
    std::string getStartCumulativeMetersetWeightTag() const { return "(300c,0008)"; }
    bool setStartCumulativeMetersetWeight(std::string parameter);
    
    // XRayImageReceptorAngle (3002,000e) vr=DS, vm=1, type=3
    bool getXRayImageReceptorAngle(std::string& parameter) const;
    std::string getXRayImageReceptorAngleTag() const { return "(3002,000e)"; }
    bool setXRayImageReceptorAngle(std::string parameter);
    
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTPlannedVerificationImageSequenceInterface()  { }
    
    DcmDRTPlannedVerificationImageSequenceInterface(std::vector<DcmDRTPlannedVerificationImageSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTPlannedVerificationImageSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTPlannedVerificationImageSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTPlannedVerificationImageSequenceInterface() {} 
    // EndCumulativeMetersetWeight (300c,0009) vr=DS, vm=1, type=3
    bool getEndCumulativeMetersetWeight(unsigned long idx, std::string& parameter) const;
    bool getEndCumulativeMetersetWeight(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getEndCumulativeMetersetWeightTag() const { return "(300c,0009)"; }
    bool setEndCumulativeMetersetWeight(unsigned long idx, std::string parameter);
    
    // ImagingDeviceSpecificAcquisitionParameters (300a,00cc) vr=LO, vm=1-n, type=3
    bool getImagingDeviceSpecificAcquisitionParameters(unsigned long idx, std::string& parameter) const;
    bool getImagingDeviceSpecificAcquisitionParameters(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getImagingDeviceSpecificAcquisitionParametersTag() const { return "(300a,00cc)"; }
    bool setImagingDeviceSpecificAcquisitionParameters(unsigned long idx, std::string parameter);
    
    // MetersetExposure (3002,0032) vr=DS, vm=1, type=3
    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);
    
    // RTImageOrientation (3002,0010) vr=DS, vm=6, type=3
    bool getRTImageOrientation(unsigned long idx, std::string& parameter) const;
    bool getRTImageOrientation(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRTImageOrientationTag() const { return "(3002,0010)"; }
    bool setRTImageOrientation(unsigned long idx, std::string parameter);
    
    // RTImagePlane (3002,000c) vr=CS, vm=1, type=3
    bool getRTImagePlane(unsigned long idx, std::string& parameter) const;
    bool getRTImagePlane(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRTImagePlaneTag() const { return "(3002,000c)"; }
    bool setRTImagePlane(unsigned long idx, std::string parameter);
    
    // RTImagePosition (3002,0012) vr=DS, vm=2, type=3
    bool getRTImagePosition(unsigned long idx, std::string& parameter) const;
    bool getRTImagePosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRTImagePositionTag() const { return "(3002,0012)"; }
    bool setRTImagePosition(unsigned long idx, std::string parameter);
    
    // RTImageSID (3002,0026) vr=DS, vm=1, type=3
    bool getRTImageSID(unsigned long idx, std::string& parameter) const;
    bool getRTImageSID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRTImageSIDTag() const { return "(3002,0026)"; }
    bool setRTImageSID(unsigned long idx, std::string parameter);
    
    // ReferencedReferenceImageNumber (300c,0007) vr=IS, vm=1, type=3
    bool getReferencedReferenceImageNumber(unsigned long idx, std::string& parameter) const;
    bool getReferencedReferenceImageNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedReferenceImageNumberTag() const { return "(300c,0007)"; }
    bool setReferencedReferenceImageNumber(unsigned long idx, std::string parameter);
    
    // StartCumulativeMetersetWeight (300c,0008) vr=DS, vm=1, type=3
    bool getStartCumulativeMetersetWeight(unsigned long idx, std::string& parameter) const;
    bool getStartCumulativeMetersetWeight(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getStartCumulativeMetersetWeightTag() const { return "(300c,0008)"; }
    bool setStartCumulativeMetersetWeight(unsigned long idx, std::string parameter);
    
    // XRayImageReceptorAngle (3002,000e) vr=DS, vm=1, type=3
    bool getXRayImageReceptorAngle(unsigned long idx, std::string& parameter) const;
    bool getXRayImageReceptorAngle(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getXRayImageReceptorAngleTag() const { return "(3002,000e)"; }
    bool setXRayImageReceptorAngle(unsigned long idx, std::string parameter);
     
    
    void setSequence(std::vector<DcmDRTPlannedVerificationImageSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTPlannedVerificationImageSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTPlannedVerificationImageSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTPlannedVerificationImageSequenceInterface::Item();
    }
    
    DcmDRTPlannedVerificationImageSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTPlannedVerificationImageSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTPlannedVerificationImageSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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