mlDcmDRTChannelSequenceInterface.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 __mlDcmDRTChannelSequenceInterface_H
#define __mlDcmDRTChannelSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTChannelSequenceInterface.h" //DRTChannelSequence
#include "mlDcmDRTBrachyControlPointSequenceInterface.h" //DRTBrachyControlPointSequence
#include "mlDcmDRTChannelShieldSequenceInterface.h" //DRTChannelShieldSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTChannelSequenceInterface
{
  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; }
 
      
    // ChannelLength (300a,0284) vr=DS, vm=1, type=2
    bool getChannelLength(std::string& parameter) const;
    std::string getChannelLengthTag() const { return "(300a,0284)"; }
    bool setChannelLength(std::string parameter);
    
    // ChannelNumber (300a,0282) vr=IS, vm=1, type=1
    bool getChannelNumber(std::string& parameter) const;
    std::string getChannelNumberTag() const { return "(300a,0282)"; }
    bool setChannelNumber(std::string parameter);
    
    // ChannelTotalTime (300a,0286) vr=DS, vm=1, type=1
    bool getChannelTotalTime(std::string& parameter) const;
    std::string getChannelTotalTimeTag() const { return "(300a,0286)"; }
    bool setChannelTotalTime(std::string parameter);
    
    // FinalCumulativeTimeWeight (300a,02c8) vr=DS, vm=1, type=1C
    bool getFinalCumulativeTimeWeight(std::string& parameter) const;
    std::string getFinalCumulativeTimeWeightTag() const { return "(300a,02c8)"; }
    bool setFinalCumulativeTimeWeight(std::string parameter);
    
    // 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);
    
    // NumberOfControlPoints (300a,0110) vr=IS, vm=1, type=1
    bool getNumberOfControlPoints(std::string& parameter) const;
    std::string getNumberOfControlPointsTag() const { return "(300a,0110)"; }
    bool setNumberOfControlPoints(std::string parameter);
    
    // NumberOfPulses (300a,028a) vr=IS, vm=1, type=1C
    bool getNumberOfPulses(std::string& parameter) const;
    std::string getNumberOfPulsesTag() const { return "(300a,028a)"; }
    bool setNumberOfPulses(std::string parameter);
    
    // PulseRepetitionInterval (300a,028c) vr=DS, vm=1, type=1C
    bool getPulseRepetitionInterval(std::string& parameter) const;
    std::string getPulseRepetitionIntervalTag() const { return "(300a,028c)"; }
    bool setPulseRepetitionInterval(std::string parameter);
    
    // ReferencedROINumber (3006,0084) vr=IS, vm=1, type=2C
    bool getReferencedROINumber(std::string& parameter) const;
    std::string getReferencedROINumberTag() const { return "(3006,0084)"; }
    bool setReferencedROINumber(std::string parameter);
    
    // ReferencedSourceNumber (300c,000e) vr=IS, vm=1, type=1
    bool getReferencedSourceNumber(std::string& parameter) const;
    std::string getReferencedSourceNumberTag() const { return "(300c,000e)"; }
    bool setReferencedSourceNumber(std::string parameter);
    
    // SourceApplicatorID (300a,0291) vr=SH, vm=1, type=2C
    bool getSourceApplicatorID(std::string& parameter) const;
    std::string getSourceApplicatorIDTag() const { return "(300a,0291)"; }
    bool setSourceApplicatorID(std::string parameter);
    
    // SourceApplicatorLength (300a,0296) vr=DS, vm=1, type=1C
    bool getSourceApplicatorLength(std::string& parameter) const;
    std::string getSourceApplicatorLengthTag() const { return "(300a,0296)"; }
    bool setSourceApplicatorLength(std::string parameter);
    
    // SourceApplicatorManufacturer (300a,0298) vr=LO, vm=1, type=3
    bool getSourceApplicatorManufacturer(std::string& parameter) const;
    std::string getSourceApplicatorManufacturerTag() const { return "(300a,0298)"; }
    bool setSourceApplicatorManufacturer(std::string parameter);
    
    // SourceApplicatorName (300a,0294) vr=LO, vm=1, type=3
    bool getSourceApplicatorName(std::string& parameter) const;
    std::string getSourceApplicatorNameTag() const { return "(300a,0294)"; }
    bool setSourceApplicatorName(std::string parameter);
    
    // SourceApplicatorNumber (300a,0290) vr=IS, vm=1, type=3
    bool getSourceApplicatorNumber(std::string& parameter) const;
    std::string getSourceApplicatorNumberTag() const { return "(300a,0290)"; }
    bool setSourceApplicatorNumber(std::string parameter);
    
    // SourceApplicatorStepSize (300a,02a0) vr=DS, vm=1, type=1C
    bool getSourceApplicatorStepSize(std::string& parameter) const;
    std::string getSourceApplicatorStepSizeTag() const { return "(300a,02a0)"; }
    bool setSourceApplicatorStepSize(std::string parameter);
    
    // SourceApplicatorType (300a,0292) vr=CS, vm=1, type=1C
    bool getSourceApplicatorType(std::string& parameter) const;
    std::string getSourceApplicatorTypeTag() const { return "(300a,0292)"; }
    bool setSourceApplicatorType(std::string parameter);
    
    // SourceApplicatorWallNominalThickness (300a,029c) vr=DS, vm=1, type=3
    bool getSourceApplicatorWallNominalThickness(std::string& parameter) const;
    std::string getSourceApplicatorWallNominalThicknessTag() const { return "(300a,029c)"; }
    bool setSourceApplicatorWallNominalThickness(std::string parameter);
    
    // SourceApplicatorWallNominalTransmission (300a,029e) vr=DS, vm=1, type=3
    bool getSourceApplicatorWallNominalTransmission(std::string& parameter) const;
    std::string getSourceApplicatorWallNominalTransmissionTag() const { return "(300a,029e)"; }
    bool setSourceApplicatorWallNominalTransmission(std::string parameter);
    
    // SourceMovementType (300a,0288) vr=CS, vm=1, type=1
    bool getSourceMovementType(std::string& parameter) const;
    std::string getSourceMovementTypeTag() const { return "(300a,0288)"; }
    bool setSourceMovementType(std::string parameter);
    
    // TransferTubeLength (300a,02a4) vr=DS, vm=1, type=2C
    bool getTransferTubeLength(std::string& parameter) const;
    std::string getTransferTubeLengthTag() const { return "(300a,02a4)"; }
    bool setTransferTubeLength(std::string parameter);
    
    // TransferTubeNumber (300a,02a2) vr=IS, vm=1, type=2
    bool getTransferTubeNumber(std::string& parameter) const;
    std::string getTransferTubeNumberTag() const { return "(300a,02a2)"; }
    bool setTransferTubeNumber(std::string parameter);
    
    // BrachyControlPointSequence (300a,02d0) vr=SQ, vm=1, type=1
    DcmDRTBrachyControlPointSequenceInterface getBrachyControlPointSequence() const;
    std::string getBrachyControlPointSequenceTag() const { return std::string("(300a,02d0)"); }
    void setBrachyControlPointSequence(DcmDRTBrachyControlPointSequenceInterface seq);
 
    // ChannelShieldSequence (300a,02b0) vr=SQ, vm=1, type=3
    DcmDRTChannelShieldSequenceInterface getChannelShieldSequence() const;
    std::string getChannelShieldSequenceTag() const { return std::string("(300a,02b0)"); }
    void setChannelShieldSequence(DcmDRTChannelShieldSequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTChannelSequenceInterface()  { }
    
    DcmDRTChannelSequenceInterface(std::vector<DcmDRTChannelSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTChannelSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTChannelSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTChannelSequenceInterface() {} 
    // ChannelLength (300a,0284) vr=DS, vm=1, type=2
    bool getChannelLength(unsigned long idx, std::string& parameter) const;
    bool getChannelLength(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getChannelLengthTag() const { return "(300a,0284)"; }
    bool setChannelLength(unsigned long idx, std::string parameter);
    
    // ChannelNumber (300a,0282) vr=IS, vm=1, type=1
    bool getChannelNumber(unsigned long idx, std::string& parameter) const;
    bool getChannelNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getChannelNumberTag() const { return "(300a,0282)"; }
    bool setChannelNumber(unsigned long idx, std::string parameter);
    
    // ChannelTotalTime (300a,0286) vr=DS, vm=1, type=1
    bool getChannelTotalTime(unsigned long idx, std::string& parameter) const;
    bool getChannelTotalTime(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getChannelTotalTimeTag() const { return "(300a,0286)"; }
    bool setChannelTotalTime(unsigned long idx, std::string parameter);
    
    // FinalCumulativeTimeWeight (300a,02c8) vr=DS, vm=1, type=1C
    bool getFinalCumulativeTimeWeight(unsigned long idx, std::string& parameter) const;
    bool getFinalCumulativeTimeWeight(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFinalCumulativeTimeWeightTag() const { return "(300a,02c8)"; }
    bool setFinalCumulativeTimeWeight(unsigned long idx, std::string parameter);
    
    // 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);
    
    // NumberOfControlPoints (300a,0110) vr=IS, vm=1, type=1
    bool getNumberOfControlPoints(unsigned long idx, std::string& parameter) const;
    bool getNumberOfControlPoints(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNumberOfControlPointsTag() const { return "(300a,0110)"; }
    bool setNumberOfControlPoints(unsigned long idx, std::string parameter);
    
    // NumberOfPulses (300a,028a) vr=IS, vm=1, type=1C
    bool getNumberOfPulses(unsigned long idx, std::string& parameter) const;
    bool getNumberOfPulses(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNumberOfPulsesTag() const { return "(300a,028a)"; }
    bool setNumberOfPulses(unsigned long idx, std::string parameter);
    
    // PulseRepetitionInterval (300a,028c) vr=DS, vm=1, type=1C
    bool getPulseRepetitionInterval(unsigned long idx, std::string& parameter) const;
    bool getPulseRepetitionInterval(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPulseRepetitionIntervalTag() const { return "(300a,028c)"; }
    bool setPulseRepetitionInterval(unsigned long idx, std::string parameter);
    
    // ReferencedROINumber (3006,0084) vr=IS, vm=1, type=2C
    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);
    
    // ReferencedSourceNumber (300c,000e) vr=IS, vm=1, type=1
    bool getReferencedSourceNumber(unsigned long idx, std::string& parameter) const;
    bool getReferencedSourceNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedSourceNumberTag() const { return "(300c,000e)"; }
    bool setReferencedSourceNumber(unsigned long idx, std::string parameter);
    
    // SourceApplicatorID (300a,0291) vr=SH, vm=1, type=2C
    bool getSourceApplicatorID(unsigned long idx, std::string& parameter) const;
    bool getSourceApplicatorID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceApplicatorIDTag() const { return "(300a,0291)"; }
    bool setSourceApplicatorID(unsigned long idx, std::string parameter);
    
    // SourceApplicatorLength (300a,0296) vr=DS, vm=1, type=1C
    bool getSourceApplicatorLength(unsigned long idx, std::string& parameter) const;
    bool getSourceApplicatorLength(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceApplicatorLengthTag() const { return "(300a,0296)"; }
    bool setSourceApplicatorLength(unsigned long idx, std::string parameter);
    
    // SourceApplicatorManufacturer (300a,0298) vr=LO, vm=1, type=3
    bool getSourceApplicatorManufacturer(unsigned long idx, std::string& parameter) const;
    bool getSourceApplicatorManufacturer(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceApplicatorManufacturerTag() const { return "(300a,0298)"; }
    bool setSourceApplicatorManufacturer(unsigned long idx, std::string parameter);
    
    // SourceApplicatorName (300a,0294) vr=LO, vm=1, type=3
    bool getSourceApplicatorName(unsigned long idx, std::string& parameter) const;
    bool getSourceApplicatorName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceApplicatorNameTag() const { return "(300a,0294)"; }
    bool setSourceApplicatorName(unsigned long idx, std::string parameter);
    
    // SourceApplicatorNumber (300a,0290) vr=IS, vm=1, type=3
    bool getSourceApplicatorNumber(unsigned long idx, std::string& parameter) const;
    bool getSourceApplicatorNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceApplicatorNumberTag() const { return "(300a,0290)"; }
    bool setSourceApplicatorNumber(unsigned long idx, std::string parameter);
    
    // SourceApplicatorStepSize (300a,02a0) vr=DS, vm=1, type=1C
    bool getSourceApplicatorStepSize(unsigned long idx, std::string& parameter) const;
    bool getSourceApplicatorStepSize(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceApplicatorStepSizeTag() const { return "(300a,02a0)"; }
    bool setSourceApplicatorStepSize(unsigned long idx, std::string parameter);
    
    // SourceApplicatorType (300a,0292) vr=CS, vm=1, type=1C
    bool getSourceApplicatorType(unsigned long idx, std::string& parameter) const;
    bool getSourceApplicatorType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceApplicatorTypeTag() const { return "(300a,0292)"; }
    bool setSourceApplicatorType(unsigned long idx, std::string parameter);
    
    // SourceApplicatorWallNominalThickness (300a,029c) vr=DS, vm=1, type=3
    bool getSourceApplicatorWallNominalThickness(unsigned long idx, std::string& parameter) const;
    bool getSourceApplicatorWallNominalThickness(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceApplicatorWallNominalThicknessTag() const { return "(300a,029c)"; }
    bool setSourceApplicatorWallNominalThickness(unsigned long idx, std::string parameter);
    
    // SourceApplicatorWallNominalTransmission (300a,029e) vr=DS, vm=1, type=3
    bool getSourceApplicatorWallNominalTransmission(unsigned long idx, std::string& parameter) const;
    bool getSourceApplicatorWallNominalTransmission(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceApplicatorWallNominalTransmissionTag() const { return "(300a,029e)"; }
    bool setSourceApplicatorWallNominalTransmission(unsigned long idx, std::string parameter);
    
    // SourceMovementType (300a,0288) vr=CS, vm=1, type=1
    bool getSourceMovementType(unsigned long idx, std::string& parameter) const;
    bool getSourceMovementType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceMovementTypeTag() const { return "(300a,0288)"; }
    bool setSourceMovementType(unsigned long idx, std::string parameter);
    
    // TransferTubeLength (300a,02a4) vr=DS, vm=1, type=2C
    bool getTransferTubeLength(unsigned long idx, std::string& parameter) const;
    bool getTransferTubeLength(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTransferTubeLengthTag() const { return "(300a,02a4)"; }
    bool setTransferTubeLength(unsigned long idx, std::string parameter);
    
    // TransferTubeNumber (300a,02a2) vr=IS, vm=1, type=2
    bool getTransferTubeNumber(unsigned long idx, std::string& parameter) const;
    bool getTransferTubeNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTransferTubeNumberTag() const { return "(300a,02a2)"; }
    bool setTransferTubeNumber(unsigned long idx, std::string parameter);
     
    // BrachyControlPointSequence (300a,02d0) vr=SQ, vm=1, type=1
    DcmDRTBrachyControlPointSequenceInterface getBrachyControlPointSequence(unsigned long idx) const;
    std::string getBrachyControlPointSequenceTag() const { return std::string("(300a,02d0)"); }
    void setBrachyControlPointSequence(DcmDRTBrachyControlPointSequenceInterface seq, unsigned long idx);
 
    // ChannelShieldSequence (300a,02b0) vr=SQ, vm=1, type=3
    DcmDRTChannelShieldSequenceInterface getChannelShieldSequence(unsigned long idx) const;
    std::string getChannelShieldSequenceTag() const { return std::string("(300a,02b0)"); }
    void setChannelShieldSequence(DcmDRTChannelShieldSequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTChannelSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTChannelSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTChannelSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTChannelSequenceInterface::Item();
    }
    
    DcmDRTChannelSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTChannelSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTChannelSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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