mlDcmDRTPatientSetupSequenceInterface.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 __mlDcmDRTPatientSetupSequenceInterface_H
#define __mlDcmDRTPatientSetupSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTPatientSetupSequenceInterface.h" //DRTPatientSetupSequence
#include "mlDcmDRTFixationDeviceSequenceInterface.h" //DRTFixationDeviceSequence
#include "mlDcmDRTMotionSynchronizationSequenceInterface.h" //DRTMotionSynchronizationSequence
#include "mlDcmDRTReferencedSetupImageSequenceInterface.h" //DRTReferencedSetupImageSequence
#include "mlDcmDRTSetupDeviceSequenceInterface.h" //DRTSetupDeviceSequence
#include "mlDcmDRTShieldingDeviceSequenceInterface.h" //DRTShieldingDeviceSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTPatientSetupSequenceInterface
{
  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; }
 
      
    // PatientAdditionalPosition (300a,0184) vr=LO, vm=1, type=1C
    bool getPatientAdditionalPosition(std::string& parameter) const;
    std::string getPatientAdditionalPositionTag() const { return "(300a,0184)"; }
    bool setPatientAdditionalPosition(std::string parameter);
    
    // PatientPosition (0018,5100) vr=CS, vm=1, type=1C
    bool getPatientPosition(std::string& parameter) const;
    std::string getPatientPositionTag() const { return "(0018,5100)"; }
    bool setPatientPosition(std::string parameter);
    
    // PatientSetupLabel (300a,0183) vr=LO, vm=1, type=3
    bool getPatientSetupLabel(std::string& parameter) const;
    std::string getPatientSetupLabelTag() const { return "(300a,0183)"; }
    bool setPatientSetupLabel(std::string parameter);
    
    // PatientSetupNumber (300a,0182) vr=IS, vm=1, type=1
    bool getPatientSetupNumber(std::string& parameter) const;
    std::string getPatientSetupNumberTag() const { return "(300a,0182)"; }
    bool setPatientSetupNumber(std::string parameter);
    
    // SetupTechnique (300a,01b0) vr=CS, vm=1, type=3
    bool getSetupTechnique(std::string& parameter) const;
    std::string getSetupTechniqueTag() const { return "(300a,01b0)"; }
    bool setSetupTechnique(std::string parameter);
    
    // SetupTechniqueDescription (300a,01b2) vr=ST, vm=1, type=3
    bool getSetupTechniqueDescription(std::string& parameter) const;
    std::string getSetupTechniqueDescriptionTag() const { return "(300a,01b2)"; }
    bool setSetupTechniqueDescription(std::string parameter);
    
    // TableTopLateralSetupDisplacement (300a,01d6) vr=DS, vm=1, type=3
    bool getTableTopLateralSetupDisplacement(std::string& parameter) const;
    std::string getTableTopLateralSetupDisplacementTag() const { return "(300a,01d6)"; }
    bool setTableTopLateralSetupDisplacement(std::string parameter);
    
    // TableTopLongitudinalSetupDisplacement (300a,01d4) vr=DS, vm=1, type=3
    bool getTableTopLongitudinalSetupDisplacement(std::string& parameter) const;
    std::string getTableTopLongitudinalSetupDisplacementTag() const { return "(300a,01d4)"; }
    bool setTableTopLongitudinalSetupDisplacement(std::string parameter);
    
    // TableTopVerticalSetupDisplacement (300a,01d2) vr=DS, vm=1, type=3
    bool getTableTopVerticalSetupDisplacement(std::string& parameter) const;
    std::string getTableTopVerticalSetupDisplacementTag() const { return "(300a,01d2)"; }
    bool setTableTopVerticalSetupDisplacement(std::string parameter);
    
    // FixationDeviceSequence (300a,0190) vr=SQ, vm=1, type=3
    DcmDRTFixationDeviceSequenceInterface getFixationDeviceSequence() const;
    std::string getFixationDeviceSequenceTag() const { return std::string("(300a,0190)"); }
    void setFixationDeviceSequence(DcmDRTFixationDeviceSequenceInterface seq);
 
    // MotionSynchronizationSequence (300a,0410) vr=SQ, vm=1, type=3
    DcmDRTMotionSynchronizationSequenceInterface getMotionSynchronizationSequence() const;
    std::string getMotionSynchronizationSequenceTag() const { return std::string("(300a,0410)"); }
    void setMotionSynchronizationSequence(DcmDRTMotionSynchronizationSequenceInterface seq);
 
    // ReferencedSetupImageSequence (300a,0401) vr=SQ, vm=1, type=3
    DcmDRTReferencedSetupImageSequenceInterface getReferencedSetupImageSequence() const;
    std::string getReferencedSetupImageSequenceTag() const { return std::string("(300a,0401)"); }
    void setReferencedSetupImageSequence(DcmDRTReferencedSetupImageSequenceInterface seq);
 
    // SetupDeviceSequence (300a,01b4) vr=SQ, vm=1, type=3
    DcmDRTSetupDeviceSequenceInterface getSetupDeviceSequence() const;
    std::string getSetupDeviceSequenceTag() const { return std::string("(300a,01b4)"); }
    void setSetupDeviceSequence(DcmDRTSetupDeviceSequenceInterface seq);
 
    // ShieldingDeviceSequence (300a,01a0) vr=SQ, vm=1, type=3
    DcmDRTShieldingDeviceSequenceInterface getShieldingDeviceSequence() const;
    std::string getShieldingDeviceSequenceTag() const { return std::string("(300a,01a0)"); }
    void setShieldingDeviceSequence(DcmDRTShieldingDeviceSequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTPatientSetupSequenceInterface()  { }
    
    DcmDRTPatientSetupSequenceInterface(std::vector<DcmDRTPatientSetupSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTPatientSetupSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTPatientSetupSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTPatientSetupSequenceInterface() {} 
    // PatientAdditionalPosition (300a,0184) vr=LO, vm=1, type=1C
    bool getPatientAdditionalPosition(unsigned long idx, std::string& parameter) const;
    bool getPatientAdditionalPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPatientAdditionalPositionTag() const { return "(300a,0184)"; }
    bool setPatientAdditionalPosition(unsigned long idx, std::string parameter);
    
    // PatientPosition (0018,5100) vr=CS, vm=1, type=1C
    bool getPatientPosition(unsigned long idx, std::string& parameter) const;
    bool getPatientPosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPatientPositionTag() const { return "(0018,5100)"; }
    bool setPatientPosition(unsigned long idx, std::string parameter);
    
    // PatientSetupLabel (300a,0183) vr=LO, vm=1, type=3
    bool getPatientSetupLabel(unsigned long idx, std::string& parameter) const;
    bool getPatientSetupLabel(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPatientSetupLabelTag() const { return "(300a,0183)"; }
    bool setPatientSetupLabel(unsigned long idx, std::string parameter);
    
    // PatientSetupNumber (300a,0182) vr=IS, vm=1, type=1
    bool getPatientSetupNumber(unsigned long idx, std::string& parameter) const;
    bool getPatientSetupNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPatientSetupNumberTag() const { return "(300a,0182)"; }
    bool setPatientSetupNumber(unsigned long idx, std::string parameter);
    
    // SetupTechnique (300a,01b0) vr=CS, vm=1, type=3
    bool getSetupTechnique(unsigned long idx, std::string& parameter) const;
    bool getSetupTechnique(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSetupTechniqueTag() const { return "(300a,01b0)"; }
    bool setSetupTechnique(unsigned long idx, std::string parameter);
    
    // SetupTechniqueDescription (300a,01b2) vr=ST, vm=1, type=3
    bool getSetupTechniqueDescription(unsigned long idx, std::string& parameter) const;
    bool getSetupTechniqueDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSetupTechniqueDescriptionTag() const { return "(300a,01b2)"; }
    bool setSetupTechniqueDescription(unsigned long idx, std::string parameter);
    
    // TableTopLateralSetupDisplacement (300a,01d6) vr=DS, vm=1, type=3
    bool getTableTopLateralSetupDisplacement(unsigned long idx, std::string& parameter) const;
    bool getTableTopLateralSetupDisplacement(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTableTopLateralSetupDisplacementTag() const { return "(300a,01d6)"; }
    bool setTableTopLateralSetupDisplacement(unsigned long idx, std::string parameter);
    
    // TableTopLongitudinalSetupDisplacement (300a,01d4) vr=DS, vm=1, type=3
    bool getTableTopLongitudinalSetupDisplacement(unsigned long idx, std::string& parameter) const;
    bool getTableTopLongitudinalSetupDisplacement(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTableTopLongitudinalSetupDisplacementTag() const { return "(300a,01d4)"; }
    bool setTableTopLongitudinalSetupDisplacement(unsigned long idx, std::string parameter);
    
    // TableTopVerticalSetupDisplacement (300a,01d2) vr=DS, vm=1, type=3
    bool getTableTopVerticalSetupDisplacement(unsigned long idx, std::string& parameter) const;
    bool getTableTopVerticalSetupDisplacement(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTableTopVerticalSetupDisplacementTag() const { return "(300a,01d2)"; }
    bool setTableTopVerticalSetupDisplacement(unsigned long idx, std::string parameter);
     
    // FixationDeviceSequence (300a,0190) vr=SQ, vm=1, type=3
    DcmDRTFixationDeviceSequenceInterface getFixationDeviceSequence(unsigned long idx) const;
    std::string getFixationDeviceSequenceTag() const { return std::string("(300a,0190)"); }
    void setFixationDeviceSequence(DcmDRTFixationDeviceSequenceInterface seq, unsigned long idx);
 
    // MotionSynchronizationSequence (300a,0410) vr=SQ, vm=1, type=3
    DcmDRTMotionSynchronizationSequenceInterface getMotionSynchronizationSequence(unsigned long idx) const;
    std::string getMotionSynchronizationSequenceTag() const { return std::string("(300a,0410)"); }
    void setMotionSynchronizationSequence(DcmDRTMotionSynchronizationSequenceInterface seq, unsigned long idx);
 
    // ReferencedSetupImageSequence (300a,0401) vr=SQ, vm=1, type=3
    DcmDRTReferencedSetupImageSequenceInterface getReferencedSetupImageSequence(unsigned long idx) const;
    std::string getReferencedSetupImageSequenceTag() const { return std::string("(300a,0401)"); }
    void setReferencedSetupImageSequence(DcmDRTReferencedSetupImageSequenceInterface seq, unsigned long idx);
 
    // SetupDeviceSequence (300a,01b4) vr=SQ, vm=1, type=3
    DcmDRTSetupDeviceSequenceInterface getSetupDeviceSequence(unsigned long idx) const;
    std::string getSetupDeviceSequenceTag() const { return std::string("(300a,01b4)"); }
    void setSetupDeviceSequence(DcmDRTSetupDeviceSequenceInterface seq, unsigned long idx);
 
    // ShieldingDeviceSequence (300a,01a0) vr=SQ, vm=1, type=3
    DcmDRTShieldingDeviceSequenceInterface getShieldingDeviceSequence(unsigned long idx) const;
    std::string getShieldingDeviceSequenceTag() const { return std::string("(300a,01a0)"); }
    void setShieldingDeviceSequence(DcmDRTShieldingDeviceSequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTPatientSetupSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTPatientSetupSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTPatientSetupSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTPatientSetupSequenceInterface::Item();
    }
    
    DcmDRTPatientSetupSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTPatientSetupSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTPatientSetupSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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