mlDcmDRTFractionGroupSummarySequenceInterface.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 __mlDcmDRTFractionGroupSummarySequenceInterface_H
#define __mlDcmDRTFractionGroupSummarySequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTFractionGroupSummarySequenceInterface.h" //DRTFractionGroupSummarySequence
#include "mlDcmDRTFractionStatusSummarySequenceInterface.h" //DRTFractionStatusSummarySequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTFractionGroupSummarySequenceInterface
{
  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; }
 
      
    // CumulativeDoseToDoseReference (3008,0052) vr=DS, vm=1, type=1C
    bool getCumulativeDoseToDoseReference(std::string& parameter) const;
    std::string getCumulativeDoseToDoseReferenceTag() const { return "(3008,0052)"; }
    bool setCumulativeDoseToDoseReference(std::string parameter);
    
    // DoseReferenceDescription (300a,0016) vr=LO, vm=1, type=3
    bool getDoseReferenceDescription(std::string& parameter) const;
    std::string getDoseReferenceDescriptionTag() const { return "(300a,0016)"; }
    bool setDoseReferenceDescription(std::string parameter);
    
    // FractionGroupType (3008,0224) vr=CS, vm=1, type=2C
    bool getFractionGroupType(std::string& parameter) const;
    std::string getFractionGroupTypeTag() const { return "(3008,0224)"; }
    bool setFractionGroupType(std::string parameter);
    
    // NumberOfFractionsDelivered (3008,005a) vr=IS, vm=1, type=2C
    bool getNumberOfFractionsDelivered(std::string& parameter) const;
    std::string getNumberOfFractionsDeliveredTag() const { return "(3008,005a)"; }
    bool setNumberOfFractionsDelivered(std::string parameter);
    
    // NumberOfFractionsPlanned (300a,0078) vr=IS, vm=1, type=2C
    bool getNumberOfFractionsPlanned(std::string& parameter) const;
    std::string getNumberOfFractionsPlannedTag() const { return "(300a,0078)"; }
    bool setNumberOfFractionsPlanned(std::string parameter);
    
    // ReferencedDoseReferenceNumber (300c,0051) vr=IS, vm=1, type=3
    bool getReferencedDoseReferenceNumber(std::string& parameter) const;
    std::string getReferencedDoseReferenceNumberTag() const { return "(300c,0051)"; }
    bool setReferencedDoseReferenceNumber(std::string parameter);
    
    // ReferencedFractionGroupNumber (300c,0022) vr=IS, vm=1, type=3
    bool getReferencedFractionGroupNumber(std::string& parameter) const;
    std::string getReferencedFractionGroupNumberTag() const { return "(300c,0022)"; }
    bool setReferencedFractionGroupNumber(std::string parameter);
    
    // FractionStatusSummarySequence (3008,0240) vr=SQ, vm=1, type=3
    DcmDRTFractionStatusSummarySequenceInterface getFractionStatusSummarySequence() const;
    std::string getFractionStatusSummarySequenceTag() const { return std::string("(3008,0240)"); }
    void setFractionStatusSummarySequence(DcmDRTFractionStatusSummarySequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTFractionGroupSummarySequenceInterface()  { }
    
    DcmDRTFractionGroupSummarySequenceInterface(std::vector<DcmDRTFractionGroupSummarySequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTFractionGroupSummarySequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTFractionGroupSummarySequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTFractionGroupSummarySequenceInterface() {} 
    // CumulativeDoseToDoseReference (3008,0052) vr=DS, vm=1, type=1C
    bool getCumulativeDoseToDoseReference(unsigned long idx, std::string& parameter) const;
    bool getCumulativeDoseToDoseReference(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getCumulativeDoseToDoseReferenceTag() const { return "(3008,0052)"; }
    bool setCumulativeDoseToDoseReference(unsigned long idx, std::string parameter);
    
    // DoseReferenceDescription (300a,0016) vr=LO, vm=1, type=3
    bool getDoseReferenceDescription(unsigned long idx, std::string& parameter) const;
    bool getDoseReferenceDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDoseReferenceDescriptionTag() const { return "(300a,0016)"; }
    bool setDoseReferenceDescription(unsigned long idx, std::string parameter);
    
    // FractionGroupType (3008,0224) vr=CS, vm=1, type=2C
    bool getFractionGroupType(unsigned long idx, std::string& parameter) const;
    bool getFractionGroupType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFractionGroupTypeTag() const { return "(3008,0224)"; }
    bool setFractionGroupType(unsigned long idx, std::string parameter);
    
    // NumberOfFractionsDelivered (3008,005a) vr=IS, vm=1, type=2C
    bool getNumberOfFractionsDelivered(unsigned long idx, std::string& parameter) const;
    bool getNumberOfFractionsDelivered(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNumberOfFractionsDeliveredTag() const { return "(3008,005a)"; }
    bool setNumberOfFractionsDelivered(unsigned long idx, std::string parameter);
    
    // NumberOfFractionsPlanned (300a,0078) vr=IS, vm=1, type=2C
    bool getNumberOfFractionsPlanned(unsigned long idx, std::string& parameter) const;
    bool getNumberOfFractionsPlanned(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNumberOfFractionsPlannedTag() const { return "(300a,0078)"; }
    bool setNumberOfFractionsPlanned(unsigned long idx, std::string parameter);
    
    // ReferencedDoseReferenceNumber (300c,0051) vr=IS, vm=1, type=3
    bool getReferencedDoseReferenceNumber(unsigned long idx, std::string& parameter) const;
    bool getReferencedDoseReferenceNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedDoseReferenceNumberTag() const { return "(300c,0051)"; }
    bool setReferencedDoseReferenceNumber(unsigned long idx, std::string parameter);
    
    // ReferencedFractionGroupNumber (300c,0022) vr=IS, vm=1, type=3
    bool getReferencedFractionGroupNumber(unsigned long idx, std::string& parameter) const;
    bool getReferencedFractionGroupNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getReferencedFractionGroupNumberTag() const { return "(300c,0022)"; }
    bool setReferencedFractionGroupNumber(unsigned long idx, std::string parameter);
     
    // FractionStatusSummarySequence (3008,0240) vr=SQ, vm=1, type=3
    DcmDRTFractionStatusSummarySequenceInterface getFractionStatusSummarySequence(unsigned long idx) const;
    std::string getFractionStatusSummarySequenceTag() const { return std::string("(3008,0240)"); }
    void setFractionStatusSummarySequence(DcmDRTFractionStatusSummarySequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTFractionGroupSummarySequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTFractionGroupSummarySequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTFractionGroupSummarySequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTFractionGroupSummarySequenceInterface::Item();
    }
    
    DcmDRTFractionGroupSummarySequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTFractionGroupSummarySequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTFractionGroupSummarySequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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