mlDcmDRTRequestAttributesSequenceInterface.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 __mlDcmDRTRequestAttributesSequenceInterface_H
#define __mlDcmDRTRequestAttributesSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTRequestAttributesSequenceInterface.h" //DRTRequestAttributesSequence
#include "mlDcmDRTReasonForRequestedProcedureCodeSequenceInterface.h" //DRTReasonForRequestedProcedureCodeSequence
#include "mlDcmDRTReferencedStudySequenceInterface.h" //DRTReferencedStudySequence
#include "mlDcmDRTRequestedProcedureCodeSequenceInterface.h" //DRTRequestedProcedureCodeSequence
#include "mlDcmDRTScheduledProtocolCodeSequenceInterface.h" //DRTScheduledProtocolCodeSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTRequestAttributesSequenceInterface
{
  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; }
 
      
    // AccessionNumber (0008,0050) vr=SH, vm=1, type=3
    bool getAccessionNumber(std::string& parameter) const;
    std::string getAccessionNumberTag() const { return "(0008,0050)"; }
    bool setAccessionNumber(std::string parameter);
    
    // ReasonForTheRequestedProcedure (0040,1002) vr=LO, vm=1, type=3
    bool getReasonForTheRequestedProcedure(std::string& parameter) const;
    std::string getReasonForTheRequestedProcedureTag() const { return "(0040,1002)"; }
    bool setReasonForTheRequestedProcedure(std::string parameter);
    
    // RequestedProcedureDescription (0032,1060) vr=LO, vm=1, type=3
    bool getRequestedProcedureDescription(std::string& parameter) const;
    std::string getRequestedProcedureDescriptionTag() const { return "(0032,1060)"; }
    bool setRequestedProcedureDescription(std::string parameter);
    
    // RequestedProcedureID (0040,1001) vr=SH, vm=1, type=1
    bool getRequestedProcedureID(std::string& parameter) const;
    std::string getRequestedProcedureIDTag() const { return "(0040,1001)"; }
    bool setRequestedProcedureID(std::string parameter);
    
    // ScheduledProcedureStepDescription (0040,0007) vr=LO, vm=1, type=3
    bool getScheduledProcedureStepDescription(std::string& parameter) const;
    std::string getScheduledProcedureStepDescriptionTag() const { return "(0040,0007)"; }
    bool setScheduledProcedureStepDescription(std::string parameter);
    
    // ScheduledProcedureStepID (0040,0009) vr=SH, vm=1, type=1
    bool getScheduledProcedureStepID(std::string& parameter) const;
    std::string getScheduledProcedureStepIDTag() const { return "(0040,0009)"; }
    bool setScheduledProcedureStepID(std::string parameter);
    
    // StudyInstanceUID (0020,000d) vr=UI, vm=1, type=3
    bool getStudyInstanceUID(std::string& parameter) const;
    std::string getStudyInstanceUIDTag() const { return "(0020,000d)"; }
    bool setStudyInstanceUID(std::string parameter);
    
    // ReasonForRequestedProcedureCodeSequence (0040,100a) vr=SQ, vm=1, type=3
    DcmDRTReasonForRequestedProcedureCodeSequenceInterface getReasonForRequestedProcedureCodeSequence() const;
    std::string getReasonForRequestedProcedureCodeSequenceTag() const { return std::string("(0040,100a)"); }
    void setReasonForRequestedProcedureCodeSequence(DcmDRTReasonForRequestedProcedureCodeSequenceInterface seq);
 
    // ReferencedStudySequence (0008,1110) vr=SQ, vm=1, type=3
    DcmDRTReferencedStudySequenceInterface getReferencedStudySequence() const;
    std::string getReferencedStudySequenceTag() const { return std::string("(0008,1110)"); }
    void setReferencedStudySequence(DcmDRTReferencedStudySequenceInterface seq);
 
    // RequestedProcedureCodeSequence (0032,1064) vr=SQ, vm=1, type=3
    DcmDRTRequestedProcedureCodeSequenceInterface getRequestedProcedureCodeSequence() const;
    std::string getRequestedProcedureCodeSequenceTag() const { return std::string("(0032,1064)"); }
    void setRequestedProcedureCodeSequence(DcmDRTRequestedProcedureCodeSequenceInterface seq);
 
    // ScheduledProtocolCodeSequence (0040,0008) vr=SQ, vm=1, type=3
    DcmDRTScheduledProtocolCodeSequenceInterface getScheduledProtocolCodeSequence() const;
    std::string getScheduledProtocolCodeSequenceTag() const { return std::string("(0040,0008)"); }
    void setScheduledProtocolCodeSequence(DcmDRTScheduledProtocolCodeSequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTRequestAttributesSequenceInterface()  { }
    
    DcmDRTRequestAttributesSequenceInterface(std::vector<DcmDRTRequestAttributesSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTRequestAttributesSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTRequestAttributesSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTRequestAttributesSequenceInterface() {} 
    // AccessionNumber (0008,0050) vr=SH, vm=1, type=3
    bool getAccessionNumber(unsigned long idx, std::string& parameter) const;
    bool getAccessionNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getAccessionNumberTag() const { return "(0008,0050)"; }
    bool setAccessionNumber(unsigned long idx, std::string parameter);
    
    // ReasonForTheRequestedProcedure (0040,1002) vr=LO, vm=1, type=3
    bool getReasonForTheRequestedProcedure(unsigned long idx, std::string& parameter) const;
    bool getReasonForTheRequestedProcedure(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReasonForTheRequestedProcedureTag() const { return "(0040,1002)"; }
    bool setReasonForTheRequestedProcedure(unsigned long idx, std::string parameter);
    
    // RequestedProcedureDescription (0032,1060) vr=LO, vm=1, type=3
    bool getRequestedProcedureDescription(unsigned long idx, std::string& parameter) const;
    bool getRequestedProcedureDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRequestedProcedureDescriptionTag() const { return "(0032,1060)"; }
    bool setRequestedProcedureDescription(unsigned long idx, std::string parameter);
    
    // RequestedProcedureID (0040,1001) vr=SH, vm=1, type=1
    bool getRequestedProcedureID(unsigned long idx, std::string& parameter) const;
    bool getRequestedProcedureID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRequestedProcedureIDTag() const { return "(0040,1001)"; }
    bool setRequestedProcedureID(unsigned long idx, std::string parameter);
    
    // ScheduledProcedureStepDescription (0040,0007) vr=LO, vm=1, type=3
    bool getScheduledProcedureStepDescription(unsigned long idx, std::string& parameter) const;
    bool getScheduledProcedureStepDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getScheduledProcedureStepDescriptionTag() const { return "(0040,0007)"; }
    bool setScheduledProcedureStepDescription(unsigned long idx, std::string parameter);
    
    // ScheduledProcedureStepID (0040,0009) vr=SH, vm=1, type=1
    bool getScheduledProcedureStepID(unsigned long idx, std::string& parameter) const;
    bool getScheduledProcedureStepID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getScheduledProcedureStepIDTag() const { return "(0040,0009)"; }
    bool setScheduledProcedureStepID(unsigned long idx, std::string parameter);
    
    // StudyInstanceUID (0020,000d) vr=UI, vm=1, type=3
    bool getStudyInstanceUID(unsigned long idx, std::string& parameter) const;
    bool getStudyInstanceUID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getStudyInstanceUIDTag() const { return "(0020,000d)"; }
    bool setStudyInstanceUID(unsigned long idx, std::string parameter);
     
    // ReasonForRequestedProcedureCodeSequence (0040,100a) vr=SQ, vm=1, type=3
    DcmDRTReasonForRequestedProcedureCodeSequenceInterface getReasonForRequestedProcedureCodeSequence(unsigned long idx) const;
    std::string getReasonForRequestedProcedureCodeSequenceTag() const { return std::string("(0040,100a)"); }
    void setReasonForRequestedProcedureCodeSequence(DcmDRTReasonForRequestedProcedureCodeSequenceInterface seq, unsigned long idx);
 
    // ReferencedStudySequence (0008,1110) vr=SQ, vm=1, type=3
    DcmDRTReferencedStudySequenceInterface getReferencedStudySequence(unsigned long idx) const;
    std::string getReferencedStudySequenceTag() const { return std::string("(0008,1110)"); }
    void setReferencedStudySequence(DcmDRTReferencedStudySequenceInterface seq, unsigned long idx);
 
    // RequestedProcedureCodeSequence (0032,1064) vr=SQ, vm=1, type=3
    DcmDRTRequestedProcedureCodeSequenceInterface getRequestedProcedureCodeSequence(unsigned long idx) const;
    std::string getRequestedProcedureCodeSequenceTag() const { return std::string("(0032,1064)"); }
    void setRequestedProcedureCodeSequence(DcmDRTRequestedProcedureCodeSequenceInterface seq, unsigned long idx);
 
    // ScheduledProtocolCodeSequence (0040,0008) vr=SQ, vm=1, type=3
    DcmDRTScheduledProtocolCodeSequenceInterface getScheduledProtocolCodeSequence(unsigned long idx) const;
    std::string getScheduledProtocolCodeSequenceTag() const { return std::string("(0040,0008)"); }
    void setScheduledProtocolCodeSequence(DcmDRTScheduledProtocolCodeSequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTRequestAttributesSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTRequestAttributesSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTRequestAttributesSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTRequestAttributesSequenceInterface::Item();
    }
    
    DcmDRTRequestAttributesSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTRequestAttributesSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTRequestAttributesSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTRequestAttributesSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTRequestAttributesSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTRequestAttributesSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTRequestAttributesSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTRequestAttributesSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */