mlDcmDRTSourceImageSequenceInterface.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 __mlDcmDRTSourceImageSequenceInterface_H
#define __mlDcmDRTSourceImageSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTSourceImageSequenceInterface.h" //DRTSourceImageSequence
#include "mlDcmDRTPurposeOfReferenceCodeSequenceInterface.h" //DRTPurposeOfReferenceCodeSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTSourceImageSequenceInterface
{
  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; }
 
      
    // PatientOrientation (0020,0020) vr=CS, vm=2, type=1C
    bool getPatientOrientation(std::string& parameter) const;
    std::string getPatientOrientationTag() const { return "(0020,0020)"; }
    bool setPatientOrientation(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);
    
    // ReferencedSOPClassUID (0008,1150) vr=UI, vm=1, type=1
    bool getReferencedSOPClassUID(std::string& parameter) const;
    std::string getReferencedSOPClassUIDTag() const { return "(0008,1150)"; }
    bool setReferencedSOPClassUID(std::string parameter);
    
    // ReferencedSOPInstanceUID (0008,1155) vr=UI, vm=1, type=1
    bool getReferencedSOPInstanceUID(std::string& parameter) const;
    std::string getReferencedSOPInstanceUIDTag() const { return "(0008,1155)"; }
    bool setReferencedSOPInstanceUID(std::string parameter);
    
    // ReferencedSegmentNumber (0062,000b) vr=US, vm=1-n, type=1C
    bool getReferencedSegmentNumber(MLuint16& parameter) const;
    std::string getReferencedSegmentNumberTag() const { return "(0062,000b)"; }
    bool setReferencedSegmentNumber(MLuint16 parameter);
    
    // SpatialLocationsPreserved (0028,135a) vr=CS, vm=1, type=3
    bool getSpatialLocationsPreserved(std::string& parameter) const;
    std::string getSpatialLocationsPreservedTag() const { return "(0028,135a)"; }
    bool setSpatialLocationsPreserved(std::string parameter);
    
    // PurposeOfReferenceCodeSequence (0040,a170) vr=SQ, vm=1, type=3
    DcmDRTPurposeOfReferenceCodeSequenceInterface getPurposeOfReferenceCodeSequence() const;
    std::string getPurposeOfReferenceCodeSequenceTag() const { return std::string("(0040,a170)"); }
    void setPurposeOfReferenceCodeSequence(DcmDRTPurposeOfReferenceCodeSequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTSourceImageSequenceInterface()  { }
    
    DcmDRTSourceImageSequenceInterface(std::vector<DcmDRTSourceImageSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTSourceImageSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTSourceImageSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTSourceImageSequenceInterface() {} 
    // PatientOrientation (0020,0020) vr=CS, vm=2, type=1C
    bool getPatientOrientation(unsigned long idx, std::string& parameter) const;
    bool getPatientOrientation(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPatientOrientationTag() const { return "(0020,0020)"; }
    bool setPatientOrientation(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);
    
    // ReferencedSOPClassUID (0008,1150) vr=UI, vm=1, type=1
    bool getReferencedSOPClassUID(unsigned long idx, std::string& parameter) const;
    bool getReferencedSOPClassUID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedSOPClassUIDTag() const { return "(0008,1150)"; }
    bool setReferencedSOPClassUID(unsigned long idx, std::string parameter);
    
    // ReferencedSOPInstanceUID (0008,1155) vr=UI, vm=1, type=1
    bool getReferencedSOPInstanceUID(unsigned long idx, std::string& parameter) const;
    bool getReferencedSOPInstanceUID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedSOPInstanceUIDTag() const { return "(0008,1155)"; }
    bool setReferencedSOPInstanceUID(unsigned long idx, std::string parameter);
    
    // ReferencedSegmentNumber (0062,000b) vr=US, vm=1-n, type=1C
    bool getReferencedSegmentNumber(unsigned long idx, MLuint16& parameter) const;
    bool getReferencedSegmentNumber(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getReferencedSegmentNumberTag() const { return "(0062,000b)"; }
    bool setReferencedSegmentNumber(unsigned long idx, MLuint16 parameter);
    
    // SpatialLocationsPreserved (0028,135a) vr=CS, vm=1, type=3
    bool getSpatialLocationsPreserved(unsigned long idx, std::string& parameter) const;
    bool getSpatialLocationsPreserved(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSpatialLocationsPreservedTag() const { return "(0028,135a)"; }
    bool setSpatialLocationsPreserved(unsigned long idx, std::string parameter);
     
    // PurposeOfReferenceCodeSequence (0040,a170) vr=SQ, vm=1, type=3
    DcmDRTPurposeOfReferenceCodeSequenceInterface getPurposeOfReferenceCodeSequence(unsigned long idx) const;
    std::string getPurposeOfReferenceCodeSequenceTag() const { return std::string("(0040,a170)"); }
    void setPurposeOfReferenceCodeSequence(DcmDRTPurposeOfReferenceCodeSequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTSourceImageSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTSourceImageSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTSourceImageSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTSourceImageSequenceInterface::Item();
    }
    
    DcmDRTSourceImageSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTSourceImageSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTSourceImageSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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