mlDcmDRTReferencedImageSequenceInterface.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 __mlDcmDRTReferencedImageSequenceInterface_H
#define __mlDcmDRTReferencedImageSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTReferencedImageSequenceInterface.h" //DRTReferencedImageSequence
#include "mlDcmDRTPurposeOfReferenceCodeSequenceInterface.h" //DRTPurposeOfReferenceCodeSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTReferencedImageSequenceInterface
{
  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; }
 
      
    // CodeMeaning (0008,0104) vr=LO, vm=1, type=1C
    bool getCodeMeaning(std::string& parameter) const;
    std::string getCodeMeaningTag() const { return "(0008,0104)"; }
    bool setCodeMeaning(std::string parameter);
    
    // CodeValue (0008,0100) vr=SH, vm=1, type=1C
    bool getCodeValue(std::string& parameter) const;
    std::string getCodeValueTag() const { return "(0008,0100)"; }
    bool setCodeValue(std::string parameter);
    
    // CodingSchemeDesignator (0008,0102) vr=SH, vm=1, type=1C
    bool getCodingSchemeDesignator(std::string& parameter) const;
    std::string getCodingSchemeDesignatorTag() const { return "(0008,0102)"; }
    bool setCodingSchemeDesignator(std::string parameter);
    
    // CodingSchemeVersion (0008,0103) vr=SH, vm=1, type=1C
    bool getCodingSchemeVersion(std::string& parameter) const;
    std::string getCodingSchemeVersionTag() const { return "(0008,0103)"; }
    bool setCodingSchemeVersion(std::string parameter);
    
    // ContextGroupExtensionCreatorUID (0008,010d) vr=UI, vm=1, type=1C
    bool getContextGroupExtensionCreatorUID(std::string& parameter) const;
    std::string getContextGroupExtensionCreatorUIDTag() const { return "(0008,010d)"; }
    bool setContextGroupExtensionCreatorUID(std::string parameter);
    
    // ContextGroupExtensionFlag (0008,010b) vr=CS, vm=1, type=3
    bool getContextGroupExtensionFlag(std::string& parameter) const;
    std::string getContextGroupExtensionFlagTag() const { return "(0008,010b)"; }
    bool setContextGroupExtensionFlag(std::string parameter);
    
    // ContextGroupLocalVersion (0008,0107) vr=DT, vm=1, type=1C
    bool getContextGroupLocalVersion(std::string& parameter) const;
    std::string getContextGroupLocalVersionTag() const { return "(0008,0107)"; }
    bool setContextGroupLocalVersion(std::string parameter);
    
    // ContextGroupVersion (0008,0106) vr=DT, vm=1, type=1C
    bool getContextGroupVersion(std::string& parameter) const;
    std::string getContextGroupVersionTag() const { return "(0008,0106)"; }
    bool setContextGroupVersion(std::string parameter);
    
    // ContextIdentifier (0008,010f) vr=CS, vm=1, type=3
    bool getContextIdentifier(std::string& parameter) const;
    std::string getContextIdentifierTag() const { return "(0008,010f)"; }
    bool setContextIdentifier(std::string parameter);
    
    // MappingResource (0008,0105) vr=CS, vm=1, type=1C
    bool getMappingResource(std::string& parameter) const;
    std::string getMappingResourceTag() const { return "(0008,0105)"; }
    bool setMappingResource(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);
    
    // 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;
      
    };
 
    DcmDRTReferencedImageSequenceInterface()  { }
    
    DcmDRTReferencedImageSequenceInterface(std::vector<DcmDRTReferencedImageSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTReferencedImageSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTReferencedImageSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTReferencedImageSequenceInterface() {} 
    // CodeMeaning (0008,0104) vr=LO, vm=1, type=1C
    bool getCodeMeaning(unsigned long idx, std::string& parameter) const;
    bool getCodeMeaning(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCodeMeaningTag() const { return "(0008,0104)"; }
    bool setCodeMeaning(unsigned long idx, std::string parameter);
    
    // CodeValue (0008,0100) vr=SH, vm=1, type=1C
    bool getCodeValue(unsigned long idx, std::string& parameter) const;
    bool getCodeValue(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCodeValueTag() const { return "(0008,0100)"; }
    bool setCodeValue(unsigned long idx, std::string parameter);
    
    // CodingSchemeDesignator (0008,0102) vr=SH, vm=1, type=1C
    bool getCodingSchemeDesignator(unsigned long idx, std::string& parameter) const;
    bool getCodingSchemeDesignator(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCodingSchemeDesignatorTag() const { return "(0008,0102)"; }
    bool setCodingSchemeDesignator(unsigned long idx, std::string parameter);
    
    // CodingSchemeVersion (0008,0103) vr=SH, vm=1, type=1C
    bool getCodingSchemeVersion(unsigned long idx, std::string& parameter) const;
    bool getCodingSchemeVersion(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCodingSchemeVersionTag() const { return "(0008,0103)"; }
    bool setCodingSchemeVersion(unsigned long idx, std::string parameter);
    
    // ContextGroupExtensionCreatorUID (0008,010d) vr=UI, vm=1, type=1C
    bool getContextGroupExtensionCreatorUID(unsigned long idx, std::string& parameter) const;
    bool getContextGroupExtensionCreatorUID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getContextGroupExtensionCreatorUIDTag() const { return "(0008,010d)"; }
    bool setContextGroupExtensionCreatorUID(unsigned long idx, std::string parameter);
    
    // ContextGroupExtensionFlag (0008,010b) vr=CS, vm=1, type=3
    bool getContextGroupExtensionFlag(unsigned long idx, std::string& parameter) const;
    bool getContextGroupExtensionFlag(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getContextGroupExtensionFlagTag() const { return "(0008,010b)"; }
    bool setContextGroupExtensionFlag(unsigned long idx, std::string parameter);
    
    // ContextGroupLocalVersion (0008,0107) vr=DT, vm=1, type=1C
    bool getContextGroupLocalVersion(unsigned long idx, std::string& parameter) const;
    bool getContextGroupLocalVersion(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getContextGroupLocalVersionTag() const { return "(0008,0107)"; }
    bool setContextGroupLocalVersion(unsigned long idx, std::string parameter);
    
    // ContextGroupVersion (0008,0106) vr=DT, vm=1, type=1C
    bool getContextGroupVersion(unsigned long idx, std::string& parameter) const;
    bool getContextGroupVersion(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getContextGroupVersionTag() const { return "(0008,0106)"; }
    bool setContextGroupVersion(unsigned long idx, std::string parameter);
    
    // ContextIdentifier (0008,010f) vr=CS, vm=1, type=3
    bool getContextIdentifier(unsigned long idx, std::string& parameter) const;
    bool getContextIdentifier(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getContextIdentifierTag() const { return "(0008,010f)"; }
    bool setContextIdentifier(unsigned long idx, std::string parameter);
    
    // MappingResource (0008,0105) vr=CS, vm=1, type=1C
    bool getMappingResource(unsigned long idx, std::string& parameter) const;
    bool getMappingResource(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getMappingResourceTag() const { return "(0008,0105)"; }
    bool setMappingResource(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);
     
    // 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<DcmDRTReferencedImageSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTReferencedImageSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTReferencedImageSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTReferencedImageSequenceInterface::Item();
    }
    
    DcmDRTReferencedImageSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTReferencedImageSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTReferencedImageSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTReferencedImageSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTReferencedImageSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTReferencedImageSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTReferencedImageSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTReferencedImageSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */