mlDcmDRTSourceSequenceInterface.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 __mlDcmDRTSourceSequenceInterface_H
#define __mlDcmDRTSourceSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTSourceSequenceInterface.h" //DRTSourceSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTSourceSequenceInterface
{
  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; }
 
      
    // ActiveSourceDiameter (300a,0218) vr=DS, vm=1, type=3
    bool getActiveSourceDiameter(std::string& parameter) const;
    std::string getActiveSourceDiameterTag() const { return "(300a,0218)"; }
    bool setActiveSourceDiameter(std::string parameter);
    
    // ActiveSourceLength (300a,021a) vr=DS, vm=1, type=3
    bool getActiveSourceLength(std::string& parameter) const;
    std::string getActiveSourceLengthTag() const { return "(300a,021a)"; }
    bool setActiveSourceLength(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);
    
    // ReferenceAirKermaRate (300a,022a) vr=DS, vm=1, type=1
    bool getReferenceAirKermaRate(std::string& parameter) const;
    std::string getReferenceAirKermaRateTag() const { return "(300a,022a)"; }
    bool setReferenceAirKermaRate(std::string parameter);
    
    // SourceEncapsulationNominalThickness (300a,0222) vr=DS, vm=1, type=3
    bool getSourceEncapsulationNominalThickness(std::string& parameter) const;
    std::string getSourceEncapsulationNominalThicknessTag() const { return "(300a,0222)"; }
    bool setSourceEncapsulationNominalThickness(std::string parameter);
    
    // SourceEncapsulationNominalTransmission (300a,0224) vr=DS, vm=1, type=3
    bool getSourceEncapsulationNominalTransmission(std::string& parameter) const;
    std::string getSourceEncapsulationNominalTransmissionTag() const { return "(300a,0224)"; }
    bool setSourceEncapsulationNominalTransmission(std::string parameter);
    
    // SourceIsotopeHalfLife (300a,0228) vr=DS, vm=1, type=1
    bool getSourceIsotopeHalfLife(std::string& parameter) const;
    std::string getSourceIsotopeHalfLifeTag() const { return "(300a,0228)"; }
    bool setSourceIsotopeHalfLife(std::string parameter);
    
    // SourceIsotopeName (300a,0226) vr=LO, vm=1, type=1
    bool getSourceIsotopeName(std::string& parameter) const;
    std::string getSourceIsotopeNameTag() const { return "(300a,0226)"; }
    bool setSourceIsotopeName(std::string parameter);
    
    // SourceManufacturer (300a,0216) vr=LO, vm=1, type=3
    bool getSourceManufacturer(std::string& parameter) const;
    std::string getSourceManufacturerTag() const { return "(300a,0216)"; }
    bool setSourceManufacturer(std::string parameter);
    
    // SourceNumber (300a,0212) vr=IS, vm=1, type=1
    bool getSourceNumber(std::string& parameter) const;
    std::string getSourceNumberTag() const { return "(300a,0212)"; }
    bool setSourceNumber(std::string parameter);
    
    // SourceStrength (300a,022b) vr=DS, vm=1, type=1C
    bool getSourceStrength(std::string& parameter) const;
    std::string getSourceStrengthTag() const { return "(300a,022b)"; }
    bool setSourceStrength(std::string parameter);
    
    // SourceStrengthReferenceDate (300a,022c) vr=DA, vm=1, type=1
    bool getSourceStrengthReferenceDate(std::string& parameter) const;
    std::string getSourceStrengthReferenceDateTag() const { return "(300a,022c)"; }
    bool setSourceStrengthReferenceDate(std::string parameter);
    
    // SourceStrengthReferenceTime (300a,022e) vr=TM, vm=1, type=1
    bool getSourceStrengthReferenceTime(std::string& parameter) const;
    std::string getSourceStrengthReferenceTimeTag() const { return "(300a,022e)"; }
    bool setSourceStrengthReferenceTime(std::string parameter);
    
    // SourceStrengthUnits (300a,0229) vr=CS, vm=1, type=1C
    bool getSourceStrengthUnits(std::string& parameter) const;
    std::string getSourceStrengthUnitsTag() const { return "(300a,0229)"; }
    bool setSourceStrengthUnits(std::string parameter);
    
    // SourceType (300a,0214) vr=CS, vm=1, type=1
    bool getSourceType(std::string& parameter) const;
    std::string getSourceTypeTag() const { return "(300a,0214)"; }
    bool setSourceType(std::string parameter);
    
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTSourceSequenceInterface()  { }
    
    DcmDRTSourceSequenceInterface(std::vector<DcmDRTSourceSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTSourceSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTSourceSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTSourceSequenceInterface() {} 
    // ActiveSourceDiameter (300a,0218) vr=DS, vm=1, type=3
    bool getActiveSourceDiameter(unsigned long idx, std::string& parameter) const;
    bool getActiveSourceDiameter(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getActiveSourceDiameterTag() const { return "(300a,0218)"; }
    bool setActiveSourceDiameter(unsigned long idx, std::string parameter);
    
    // ActiveSourceLength (300a,021a) vr=DS, vm=1, type=3
    bool getActiveSourceLength(unsigned long idx, std::string& parameter) const;
    bool getActiveSourceLength(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getActiveSourceLengthTag() const { return "(300a,021a)"; }
    bool setActiveSourceLength(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);
    
    // ReferenceAirKermaRate (300a,022a) vr=DS, vm=1, type=1
    bool getReferenceAirKermaRate(unsigned long idx, std::string& parameter) const;
    bool getReferenceAirKermaRate(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferenceAirKermaRateTag() const { return "(300a,022a)"; }
    bool setReferenceAirKermaRate(unsigned long idx, std::string parameter);
    
    // SourceEncapsulationNominalThickness (300a,0222) vr=DS, vm=1, type=3
    bool getSourceEncapsulationNominalThickness(unsigned long idx, std::string& parameter) const;
    bool getSourceEncapsulationNominalThickness(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceEncapsulationNominalThicknessTag() const { return "(300a,0222)"; }
    bool setSourceEncapsulationNominalThickness(unsigned long idx, std::string parameter);
    
    // SourceEncapsulationNominalTransmission (300a,0224) vr=DS, vm=1, type=3
    bool getSourceEncapsulationNominalTransmission(unsigned long idx, std::string& parameter) const;
    bool getSourceEncapsulationNominalTransmission(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceEncapsulationNominalTransmissionTag() const { return "(300a,0224)"; }
    bool setSourceEncapsulationNominalTransmission(unsigned long idx, std::string parameter);
    
    // SourceIsotopeHalfLife (300a,0228) vr=DS, vm=1, type=1
    bool getSourceIsotopeHalfLife(unsigned long idx, std::string& parameter) const;
    bool getSourceIsotopeHalfLife(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceIsotopeHalfLifeTag() const { return "(300a,0228)"; }
    bool setSourceIsotopeHalfLife(unsigned long idx, std::string parameter);
    
    // SourceIsotopeName (300a,0226) vr=LO, vm=1, type=1
    bool getSourceIsotopeName(unsigned long idx, std::string& parameter) const;
    bool getSourceIsotopeName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceIsotopeNameTag() const { return "(300a,0226)"; }
    bool setSourceIsotopeName(unsigned long idx, std::string parameter);
    
    // SourceManufacturer (300a,0216) vr=LO, vm=1, type=3
    bool getSourceManufacturer(unsigned long idx, std::string& parameter) const;
    bool getSourceManufacturer(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceManufacturerTag() const { return "(300a,0216)"; }
    bool setSourceManufacturer(unsigned long idx, std::string parameter);
    
    // SourceNumber (300a,0212) vr=IS, vm=1, type=1
    bool getSourceNumber(unsigned long idx, std::string& parameter) const;
    bool getSourceNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceNumberTag() const { return "(300a,0212)"; }
    bool setSourceNumber(unsigned long idx, std::string parameter);
    
    // SourceStrength (300a,022b) vr=DS, vm=1, type=1C
    bool getSourceStrength(unsigned long idx, std::string& parameter) const;
    bool getSourceStrength(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceStrengthTag() const { return "(300a,022b)"; }
    bool setSourceStrength(unsigned long idx, std::string parameter);
    
    // SourceStrengthReferenceDate (300a,022c) vr=DA, vm=1, type=1
    bool getSourceStrengthReferenceDate(unsigned long idx, std::string& parameter) const;
    bool getSourceStrengthReferenceDate(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceStrengthReferenceDateTag() const { return "(300a,022c)"; }
    bool setSourceStrengthReferenceDate(unsigned long idx, std::string parameter);
    
    // SourceStrengthReferenceTime (300a,022e) vr=TM, vm=1, type=1
    bool getSourceStrengthReferenceTime(unsigned long idx, std::string& parameter) const;
    bool getSourceStrengthReferenceTime(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceStrengthReferenceTimeTag() const { return "(300a,022e)"; }
    bool setSourceStrengthReferenceTime(unsigned long idx, std::string parameter);
    
    // SourceStrengthUnits (300a,0229) vr=CS, vm=1, type=1C
    bool getSourceStrengthUnits(unsigned long idx, std::string& parameter) const;
    bool getSourceStrengthUnits(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceStrengthUnitsTag() const { return "(300a,0229)"; }
    bool setSourceStrengthUnits(unsigned long idx, std::string parameter);
    
    // SourceType (300a,0214) vr=CS, vm=1, type=1
    bool getSourceType(unsigned long idx, std::string& parameter) const;
    bool getSourceType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSourceTypeTag() const { return "(300a,0214)"; }
    bool setSourceType(unsigned long idx, std::string parameter);
     
    
    void setSequence(std::vector<DcmDRTSourceSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTSourceSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTSourceSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTSourceSequenceInterface::Item();
    }
    
    DcmDRTSourceSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTSourceSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTSourceSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTSourceSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTSourceSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTSourceSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTSourceSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTSourceSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */