mlDcmDRTRTROIObservationsSequenceInterface.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 __mlDcmDRTRTROIObservationsSequenceInterface_H
#define __mlDcmDRTRTROIObservationsSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTRTROIObservationsSequenceInterface.h" //DRTRTROIObservationsSequence
#include "mlDcmDRTROIPhysicalPropertiesSequenceInterface.h" //DRTROIPhysicalPropertiesSequence
#include "mlDcmDRTRTROIIdentificationCodeSequenceInterface.h" //DRTRTROIIdentificationCodeSequence
#include "mlDcmDRTRTRelatedROISequenceInterface.h" //DRTRTRelatedROISequence
#include "mlDcmDRTRelatedRTROIObservationsSequenceInterface.h" //DRTRelatedRTROIObservationsSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTRTROIObservationsSequenceInterface
{
  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; }
 
      
    // MaterialID (300a,00e1) vr=SH, vm=1, type=3
    bool getMaterialID(std::string& parameter) const;
    std::string getMaterialIDTag() const { return "(300a,00e1)"; }
    bool setMaterialID(std::string parameter);
    
    // ObservationNumber (3006,0082) vr=IS, vm=1, type=1
    bool getObservationNumber(std::string& parameter) const;
    std::string getObservationNumberTag() const { return "(3006,0082)"; }
    bool setObservationNumber(std::string parameter);
    
    // ROIInterpreter (3006,00a6) vr=PN, vm=1, type=2
    bool getROIInterpreter(std::string& parameter) const;
    std::string getROIInterpreterTag() const { return "(3006,00a6)"; }
    bool setROIInterpreter(std::string parameter);
    
    // ROIObservationDescription (3006,0088) vr=ST, vm=1, type=3
    bool getROIObservationDescription(std::string& parameter) const;
    std::string getROIObservationDescriptionTag() const { return "(3006,0088)"; }
    bool setROIObservationDescription(std::string parameter);
    
    // ROIObservationLabel (3006,0085) vr=SH, vm=1, type=3
    bool getROIObservationLabel(std::string& parameter) const;
    std::string getROIObservationLabelTag() const { return "(3006,0085)"; }
    bool setROIObservationLabel(std::string parameter);
    
    // RTROIInterpretedType (3006,00a4) vr=CS, vm=1, type=2
    bool getRTROIInterpretedType(std::string& parameter) const;
    std::string getRTROIInterpretedTypeTag() const { return "(3006,00a4)"; }
    bool setRTROIInterpretedType(std::string parameter);
    
    // ReferencedROINumber (3006,0084) vr=IS, vm=1, type=1
    bool getReferencedROINumber(std::string& parameter) const;
    std::string getReferencedROINumberTag() const { return "(3006,0084)"; }
    bool setReferencedROINumber(std::string parameter);
    
    // ROIPhysicalPropertiesSequence (3006,00b0) vr=SQ, vm=1, type=3
    DcmDRTROIPhysicalPropertiesSequenceInterface getROIPhysicalPropertiesSequence() const;
    std::string getROIPhysicalPropertiesSequenceTag() const { return std::string("(3006,00b0)"); }
    void setROIPhysicalPropertiesSequence(DcmDRTROIPhysicalPropertiesSequenceInterface seq);
 
    // RTROIIdentificationCodeSequence (3006,0086) vr=SQ, vm=1, type=3
    DcmDRTRTROIIdentificationCodeSequenceInterface getRTROIIdentificationCodeSequence() const;
    std::string getRTROIIdentificationCodeSequenceTag() const { return std::string("(3006,0086)"); }
    void setRTROIIdentificationCodeSequence(DcmDRTRTROIIdentificationCodeSequenceInterface seq);
 
    // RTRelatedROISequence (3006,0030) vr=SQ, vm=1, type=3
    DcmDRTRTRelatedROISequenceInterface getRTRelatedROISequence() const;
    std::string getRTRelatedROISequenceTag() const { return std::string("(3006,0030)"); }
    void setRTRelatedROISequence(DcmDRTRTRelatedROISequenceInterface seq);
 
    // RelatedRTROIObservationsSequence (3006,00a0) vr=SQ, vm=1, type=3
    DcmDRTRelatedRTROIObservationsSequenceInterface getRelatedRTROIObservationsSequence() const;
    std::string getRelatedRTROIObservationsSequenceTag() const { return std::string("(3006,00a0)"); }
    void setRelatedRTROIObservationsSequence(DcmDRTRelatedRTROIObservationsSequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTRTROIObservationsSequenceInterface()  { }
    
    DcmDRTRTROIObservationsSequenceInterface(std::vector<DcmDRTRTROIObservationsSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTRTROIObservationsSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTRTROIObservationsSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTRTROIObservationsSequenceInterface() {} 
    // MaterialID (300a,00e1) vr=SH, vm=1, type=3
    bool getMaterialID(unsigned long idx, std::string& parameter) const;
    bool getMaterialID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getMaterialIDTag() const { return "(300a,00e1)"; }
    bool setMaterialID(unsigned long idx, std::string parameter);
    
    // ObservationNumber (3006,0082) vr=IS, vm=1, type=1
    bool getObservationNumber(unsigned long idx, std::string& parameter) const;
    bool getObservationNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getObservationNumberTag() const { return "(3006,0082)"; }
    bool setObservationNumber(unsigned long idx, std::string parameter);
    
    // ROIInterpreter (3006,00a6) vr=PN, vm=1, type=2
    bool getROIInterpreter(unsigned long idx, std::string& parameter) const;
    bool getROIInterpreter(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getROIInterpreterTag() const { return "(3006,00a6)"; }
    bool setROIInterpreter(unsigned long idx, std::string parameter);
    
    // ROIObservationDescription (3006,0088) vr=ST, vm=1, type=3
    bool getROIObservationDescription(unsigned long idx, std::string& parameter) const;
    bool getROIObservationDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getROIObservationDescriptionTag() const { return "(3006,0088)"; }
    bool setROIObservationDescription(unsigned long idx, std::string parameter);
    
    // ROIObservationLabel (3006,0085) vr=SH, vm=1, type=3
    bool getROIObservationLabel(unsigned long idx, std::string& parameter) const;
    bool getROIObservationLabel(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getROIObservationLabelTag() const { return "(3006,0085)"; }
    bool setROIObservationLabel(unsigned long idx, std::string parameter);
    
    // RTROIInterpretedType (3006,00a4) vr=CS, vm=1, type=2
    bool getRTROIInterpretedType(unsigned long idx, std::string& parameter) const;
    bool getRTROIInterpretedType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRTROIInterpretedTypeTag() const { return "(3006,00a4)"; }
    bool setRTROIInterpretedType(unsigned long idx, std::string parameter);
    
    // ReferencedROINumber (3006,0084) vr=IS, vm=1, type=1
    bool getReferencedROINumber(unsigned long idx, std::string& parameter) const;
    bool getReferencedROINumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedROINumberTag() const { return "(3006,0084)"; }
    bool setReferencedROINumber(unsigned long idx, std::string parameter);
     
    // ROIPhysicalPropertiesSequence (3006,00b0) vr=SQ, vm=1, type=3
    DcmDRTROIPhysicalPropertiesSequenceInterface getROIPhysicalPropertiesSequence(unsigned long idx) const;
    std::string getROIPhysicalPropertiesSequenceTag() const { return std::string("(3006,00b0)"); }
    void setROIPhysicalPropertiesSequence(DcmDRTROIPhysicalPropertiesSequenceInterface seq, unsigned long idx);
 
    // RTROIIdentificationCodeSequence (3006,0086) vr=SQ, vm=1, type=3
    DcmDRTRTROIIdentificationCodeSequenceInterface getRTROIIdentificationCodeSequence(unsigned long idx) const;
    std::string getRTROIIdentificationCodeSequenceTag() const { return std::string("(3006,0086)"); }
    void setRTROIIdentificationCodeSequence(DcmDRTRTROIIdentificationCodeSequenceInterface seq, unsigned long idx);
 
    // RTRelatedROISequence (3006,0030) vr=SQ, vm=1, type=3
    DcmDRTRTRelatedROISequenceInterface getRTRelatedROISequence(unsigned long idx) const;
    std::string getRTRelatedROISequenceTag() const { return std::string("(3006,0030)"); }
    void setRTRelatedROISequence(DcmDRTRTRelatedROISequenceInterface seq, unsigned long idx);
 
    // RelatedRTROIObservationsSequence (3006,00a0) vr=SQ, vm=1, type=3
    DcmDRTRelatedRTROIObservationsSequenceInterface getRelatedRTROIObservationsSequence(unsigned long idx) const;
    std::string getRelatedRTROIObservationsSequenceTag() const { return std::string("(3006,00a0)"); }
    void setRelatedRTROIObservationsSequence(DcmDRTRelatedRTROIObservationsSequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTRTROIObservationsSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTRTROIObservationsSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTRTROIObservationsSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTRTROIObservationsSequenceInterface::Item();
    }
    
    DcmDRTRTROIObservationsSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTRTROIObservationsSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTRTROIObservationsSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTRTROIObservationsSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTRTROIObservationsSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTRTROIObservationsSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTRTROIObservationsSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTRTROIObservationsSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */