mlDcmDRTReferencedFrameOfReferenceSequenceInterface.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 __mlDcmDRTReferencedFrameOfReferenceSequenceInterface_H
#define __mlDcmDRTReferencedFrameOfReferenceSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h" //DRTReferencedFrameOfReferenceSequence
#include "mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h" //DRTFrameOfReferenceRelationshipSequence
#include "mlDcmDRTRTReferencedStudySequenceInterface.h" //DRTRTReferencedStudySequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTReferencedFrameOfReferenceSequenceInterface
{
  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; }
 
      
    // FrameOfReferenceUID (0020,0052) vr=UI, vm=1, type=1C
    bool getFrameOfReferenceUID(std::string& parameter) const;
    std::string getFrameOfReferenceUIDTag() const { return "(0020,0052)"; }
    bool setFrameOfReferenceUID(std::string parameter);
    
    // ROIDescription (3006,0028) vr=ST, vm=1, type=3
    bool getROIDescription(std::string& parameter) const;
    std::string getROIDescriptionTag() const { return "(3006,0028)"; }
    bool setROIDescription(std::string parameter);
    
    // ROIGenerationAlgorithm (3006,0036) vr=CS, vm=1, type=2C
    bool getROIGenerationAlgorithm(std::string& parameter) const;
    std::string getROIGenerationAlgorithmTag() const { return "(3006,0036)"; }
    bool setROIGenerationAlgorithm(std::string parameter);
    
    // ROIGenerationDescription (3006,0038) vr=LO, vm=1, type=3
    bool getROIGenerationDescription(std::string& parameter) const;
    std::string getROIGenerationDescriptionTag() const { return "(3006,0038)"; }
    bool setROIGenerationDescription(std::string parameter);
    
    // ROIName (3006,0026) vr=LO, vm=1, type=2C
    bool getROIName(std::string& parameter) const;
    std::string getROINameTag() const { return "(3006,0026)"; }
    bool setROIName(std::string parameter);
    
    // ROINumber (3006,0022) vr=IS, vm=1, type=1C
    bool getROINumber(std::string& parameter) const;
    std::string getROINumberTag() const { return "(3006,0022)"; }
    bool setROINumber(std::string parameter);
    
    // ROIVolume (3006,002c) vr=DS, vm=1, type=3
    bool getROIVolume(std::string& parameter) const;
    std::string getROIVolumeTag() const { return "(3006,002c)"; }
    bool setROIVolume(std::string parameter);
    
    // ReferencedFrameOfReferenceUID (3006,0024) vr=UI, vm=1, type=1C
    bool getReferencedFrameOfReferenceUID(std::string& parameter) const;
    std::string getReferencedFrameOfReferenceUIDTag() const { return "(3006,0024)"; }
    bool setReferencedFrameOfReferenceUID(std::string parameter);
    
    // FrameOfReferenceRelationshipSequence (3006,00c0) vr=SQ, vm=1, type=3
    DcmDRTFrameOfReferenceRelationshipSequenceInterface getFrameOfReferenceRelationshipSequence() const;
    std::string getFrameOfReferenceRelationshipSequenceTag() const { return std::string("(3006,00c0)"); }
    void setFrameOfReferenceRelationshipSequence(DcmDRTFrameOfReferenceRelationshipSequenceInterface seq);
 
    // RTReferencedStudySequence (3006,0012) vr=SQ, vm=1, type=3
    DcmDRTRTReferencedStudySequenceInterface getRTReferencedStudySequence() const;
    std::string getRTReferencedStudySequenceTag() const { return std::string("(3006,0012)"); }
    void setRTReferencedStudySequence(DcmDRTRTReferencedStudySequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTReferencedFrameOfReferenceSequenceInterface()  { }
    
    DcmDRTReferencedFrameOfReferenceSequenceInterface(std::vector<DcmDRTReferencedFrameOfReferenceSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTReferencedFrameOfReferenceSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTReferencedFrameOfReferenceSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTReferencedFrameOfReferenceSequenceInterface() {} 
    // FrameOfReferenceUID (0020,0052) vr=UI, vm=1, type=1C
    bool getFrameOfReferenceUID(unsigned long idx, std::string& parameter) const;
    bool getFrameOfReferenceUID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFrameOfReferenceUIDTag() const { return "(0020,0052)"; }
    bool setFrameOfReferenceUID(unsigned long idx, std::string parameter);
    
    // ROIDescription (3006,0028) vr=ST, vm=1, type=3
    bool getROIDescription(unsigned long idx, std::string& parameter) const;
    bool getROIDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getROIDescriptionTag() const { return "(3006,0028)"; }
    bool setROIDescription(unsigned long idx, std::string parameter);
    
    // ROIGenerationAlgorithm (3006,0036) vr=CS, vm=1, type=2C
    bool getROIGenerationAlgorithm(unsigned long idx, std::string& parameter) const;
    bool getROIGenerationAlgorithm(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getROIGenerationAlgorithmTag() const { return "(3006,0036)"; }
    bool setROIGenerationAlgorithm(unsigned long idx, std::string parameter);
    
    // ROIGenerationDescription (3006,0038) vr=LO, vm=1, type=3
    bool getROIGenerationDescription(unsigned long idx, std::string& parameter) const;
    bool getROIGenerationDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getROIGenerationDescriptionTag() const { return "(3006,0038)"; }
    bool setROIGenerationDescription(unsigned long idx, std::string parameter);
    
    // ROIName (3006,0026) vr=LO, vm=1, type=2C
    bool getROIName(unsigned long idx, std::string& parameter) const;
    bool getROIName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getROINameTag() const { return "(3006,0026)"; }
    bool setROIName(unsigned long idx, std::string parameter);
    
    // ROINumber (3006,0022) vr=IS, vm=1, type=1C
    bool getROINumber(unsigned long idx, std::string& parameter) const;
    bool getROINumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getROINumberTag() const { return "(3006,0022)"; }
    bool setROINumber(unsigned long idx, std::string parameter);
    
    // ROIVolume (3006,002c) vr=DS, vm=1, type=3
    bool getROIVolume(unsigned long idx, std::string& parameter) const;
    bool getROIVolume(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getROIVolumeTag() const { return "(3006,002c)"; }
    bool setROIVolume(unsigned long idx, std::string parameter);
    
    // ReferencedFrameOfReferenceUID (3006,0024) vr=UI, vm=1, type=1C
    bool getReferencedFrameOfReferenceUID(unsigned long idx, std::string& parameter) const;
    bool getReferencedFrameOfReferenceUID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedFrameOfReferenceUIDTag() const { return "(3006,0024)"; }
    bool setReferencedFrameOfReferenceUID(unsigned long idx, std::string parameter);
     
    // FrameOfReferenceRelationshipSequence (3006,00c0) vr=SQ, vm=1, type=3
    DcmDRTFrameOfReferenceRelationshipSequenceInterface getFrameOfReferenceRelationshipSequence(unsigned long idx) const;
    std::string getFrameOfReferenceRelationshipSequenceTag() const { return std::string("(3006,00c0)"); }
    void setFrameOfReferenceRelationshipSequence(DcmDRTFrameOfReferenceRelationshipSequenceInterface seq, unsigned long idx);
 
    // RTReferencedStudySequence (3006,0012) vr=SQ, vm=1, type=3
    DcmDRTRTReferencedStudySequenceInterface getRTReferencedStudySequence(unsigned long idx) const;
    std::string getRTReferencedStudySequenceTag() const { return std::string("(3006,0012)"); }
    void setRTReferencedStudySequence(DcmDRTRTReferencedStudySequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTReferencedFrameOfReferenceSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTReferencedFrameOfReferenceSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTReferencedFrameOfReferenceSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTReferencedFrameOfReferenceSequenceInterface::Item();
    }
    
    DcmDRTReferencedFrameOfReferenceSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTReferencedFrameOfReferenceSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTReferencedFrameOfReferenceSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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