mlDcmDRTApplicationSetupSequenceInterface.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 __mlDcmDRTApplicationSetupSequenceInterface_H
#define __mlDcmDRTApplicationSetupSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTApplicationSetupSequenceInterface.h" //DRTApplicationSetupSequence
#include "mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h" //DRTBrachyAccessoryDeviceSequence
#include "mlDcmDRTChannelSequenceInterface.h" //DRTChannelSequence
#include "mlDcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface.h" //DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModule
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTApplicationSetupSequenceInterface
{
  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; }
 
      
    // ApplicationSetupManufacturer (300a,0238) vr=LO, vm=1, type=3
    bool getApplicationSetupManufacturer(std::string& parameter) const;
    std::string getApplicationSetupManufacturerTag() const { return "(300a,0238)"; }
    bool setApplicationSetupManufacturer(std::string parameter);
    
    // ApplicationSetupName (300a,0236) vr=LO, vm=1, type=3
    bool getApplicationSetupName(std::string& parameter) const;
    std::string getApplicationSetupNameTag() const { return "(300a,0236)"; }
    bool setApplicationSetupName(std::string parameter);
    
    // ApplicationSetupNumber (300a,0234) vr=IS, vm=1, type=1
    bool getApplicationSetupNumber(std::string& parameter) const;
    std::string getApplicationSetupNumberTag() const { return "(300a,0234)"; }
    bool setApplicationSetupNumber(std::string parameter);
    
    // ApplicationSetupType (300a,0232) vr=CS, vm=1, type=1
    bool getApplicationSetupType(std::string& parameter) const;
    std::string getApplicationSetupTypeTag() const { return "(300a,0232)"; }
    bool setApplicationSetupType(std::string parameter);
    
    // TemplateName (300a,0244) vr=LO, vm=1, type=3
    bool getTemplateName(std::string& parameter) const;
    std::string getTemplateNameTag() const { return "(300a,0244)"; }
    bool setTemplateName(std::string parameter);
    
    // TemplateNumber (300a,0240) vr=IS, vm=1, type=3
    bool getTemplateNumber(std::string& parameter) const;
    std::string getTemplateNumberTag() const { return "(300a,0240)"; }
    bool setTemplateNumber(std::string parameter);
    
    // TemplateType (300a,0242) vr=SH, vm=1, type=3
    bool getTemplateType(std::string& parameter) const;
    std::string getTemplateTypeTag() const { return "(300a,0242)"; }
    bool setTemplateType(std::string parameter);
    
    // TotalReferenceAirKerma (300a,0250) vr=DS, vm=1, type=1
    bool getTotalReferenceAirKerma(std::string& parameter) const;
    std::string getTotalReferenceAirKermaTag() const { return "(300a,0250)"; }
    bool setTotalReferenceAirKerma(std::string parameter);
    
    // BrachyAccessoryDeviceSequence (300a,0260) vr=SQ, vm=1, type=3
    DcmDRTBrachyAccessoryDeviceSequenceInterface getBrachyAccessoryDeviceSequence() const;
    std::string getBrachyAccessoryDeviceSequenceTag() const { return std::string("(300a,0260)"); }
    void setBrachyAccessoryDeviceSequence(DcmDRTBrachyAccessoryDeviceSequenceInterface seq);
 
    // ChannelSequence (300a,0280) vr=SQ, vm=1, type=1
    DcmDRTChannelSequenceInterface getChannelSequence() const;
    std::string getChannelSequenceTag() const { return std::string("(300a,0280)"); }
    void setChannelSequence(DcmDRTChannelSequenceInterface seq);
 
    // ReferencedReferenceImageSequence (300c,0042) vr=SQ, vm=1, type=3
    DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface getReferencedReferenceImageSequence() const;
    std::string getReferencedReferenceImageSequenceTag() const { return std::string("(300c,0042)"); }
    void setReferencedReferenceImageSequence(DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTApplicationSetupSequenceInterface()  { }
    
    DcmDRTApplicationSetupSequenceInterface(std::vector<DcmDRTApplicationSetupSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTApplicationSetupSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTApplicationSetupSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTApplicationSetupSequenceInterface() {} 
    // ApplicationSetupManufacturer (300a,0238) vr=LO, vm=1, type=3
    bool getApplicationSetupManufacturer(unsigned long idx, std::string& parameter) const;
    bool getApplicationSetupManufacturer(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getApplicationSetupManufacturerTag() const { return "(300a,0238)"; }
    bool setApplicationSetupManufacturer(unsigned long idx, std::string parameter);
    
    // ApplicationSetupName (300a,0236) vr=LO, vm=1, type=3
    bool getApplicationSetupName(unsigned long idx, std::string& parameter) const;
    bool getApplicationSetupName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getApplicationSetupNameTag() const { return "(300a,0236)"; }
    bool setApplicationSetupName(unsigned long idx, std::string parameter);
    
    // ApplicationSetupNumber (300a,0234) vr=IS, vm=1, type=1
    bool getApplicationSetupNumber(unsigned long idx, std::string& parameter) const;
    bool getApplicationSetupNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getApplicationSetupNumberTag() const { return "(300a,0234)"; }
    bool setApplicationSetupNumber(unsigned long idx, std::string parameter);
    
    // ApplicationSetupType (300a,0232) vr=CS, vm=1, type=1
    bool getApplicationSetupType(unsigned long idx, std::string& parameter) const;
    bool getApplicationSetupType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getApplicationSetupTypeTag() const { return "(300a,0232)"; }
    bool setApplicationSetupType(unsigned long idx, std::string parameter);
    
    // TemplateName (300a,0244) vr=LO, vm=1, type=3
    bool getTemplateName(unsigned long idx, std::string& parameter) const;
    bool getTemplateName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTemplateNameTag() const { return "(300a,0244)"; }
    bool setTemplateName(unsigned long idx, std::string parameter);
    
    // TemplateNumber (300a,0240) vr=IS, vm=1, type=3
    bool getTemplateNumber(unsigned long idx, std::string& parameter) const;
    bool getTemplateNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTemplateNumberTag() const { return "(300a,0240)"; }
    bool setTemplateNumber(unsigned long idx, std::string parameter);
    
    // TemplateType (300a,0242) vr=SH, vm=1, type=3
    bool getTemplateType(unsigned long idx, std::string& parameter) const;
    bool getTemplateType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTemplateTypeTag() const { return "(300a,0242)"; }
    bool setTemplateType(unsigned long idx, std::string parameter);
    
    // TotalReferenceAirKerma (300a,0250) vr=DS, vm=1, type=1
    bool getTotalReferenceAirKerma(unsigned long idx, std::string& parameter) const;
    bool getTotalReferenceAirKerma(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTotalReferenceAirKermaTag() const { return "(300a,0250)"; }
    bool setTotalReferenceAirKerma(unsigned long idx, std::string parameter);
     
    // BrachyAccessoryDeviceSequence (300a,0260) vr=SQ, vm=1, type=3
    DcmDRTBrachyAccessoryDeviceSequenceInterface getBrachyAccessoryDeviceSequence(unsigned long idx) const;
    std::string getBrachyAccessoryDeviceSequenceTag() const { return std::string("(300a,0260)"); }
    void setBrachyAccessoryDeviceSequence(DcmDRTBrachyAccessoryDeviceSequenceInterface seq, unsigned long idx);
 
    // ChannelSequence (300a,0280) vr=SQ, vm=1, type=1
    DcmDRTChannelSequenceInterface getChannelSequence(unsigned long idx) const;
    std::string getChannelSequenceTag() const { return std::string("(300a,0280)"); }
    void setChannelSequence(DcmDRTChannelSequenceInterface seq, unsigned long idx);
 
    // ReferencedReferenceImageSequence (300c,0042) vr=SQ, vm=1, type=3
    DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface getReferencedReferenceImageSequence(unsigned long idx) const;
    std::string getReferencedReferenceImageSequenceTag() const { return std::string("(300c,0042)"); }
    void setReferencedReferenceImageSequence(DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTApplicationSetupSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTApplicationSetupSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTApplicationSetupSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTApplicationSetupSequenceInterface::Item();
    }
    
    DcmDRTApplicationSetupSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTApplicationSetupSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTApplicationSetupSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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