mlDcmDRTFractionGroupSequenceInterface.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 __mlDcmDRTFractionGroupSequenceInterface_H
#define __mlDcmDRTFractionGroupSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTFractionGroupSequenceInterface.h" //DRTFractionGroupSequence
#include "mlDcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface.h" //DRTReferencedBeamSequenceInRTFractionSchemeModule
#include "mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface.h" //DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule
#include "mlDcmDRTReferencedDoseReferenceSequenceInRTFractionSchemeModuleInterface.h" //DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule
#include "mlDcmDRTReferencedDoseSequenceInterface.h" //DRTReferencedDoseSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTFractionGroupSequenceInterface
{
  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; }
 
      
    // FractionGroupDescription (300a,0072) vr=LO, vm=1, type=3
    bool getFractionGroupDescription(std::string& parameter) const;
    std::string getFractionGroupDescriptionTag() const { return "(300a,0072)"; }
    bool setFractionGroupDescription(std::string parameter);
    
    // FractionGroupNumber (300a,0071) vr=IS, vm=1, type=1
    bool getFractionGroupNumber(std::string& parameter) const;
    std::string getFractionGroupNumberTag() const { return "(300a,0071)"; }
    bool setFractionGroupNumber(std::string parameter);
    
    // FractionPattern (300a,007b) vr=LT, vm=1, type=3
    bool getFractionPattern(std::string& parameter) const;
    std::string getFractionPatternTag() const { return "(300a,007b)"; }
    bool setFractionPattern(std::string parameter);
    
    // NumberOfBeams (300a,0080) vr=IS, vm=1, type=1
    bool getNumberOfBeams(std::string& parameter) const;
    std::string getNumberOfBeamsTag() const { return "(300a,0080)"; }
    bool setNumberOfBeams(std::string parameter);
    
    // NumberOfBrachyApplicationSetups (300a,00a0) vr=IS, vm=1, type=1
    bool getNumberOfBrachyApplicationSetups(std::string& parameter) const;
    std::string getNumberOfBrachyApplicationSetupsTag() const { return "(300a,00a0)"; }
    bool setNumberOfBrachyApplicationSetups(std::string parameter);
    
    // NumberOfFractionPatternDigitsPerDay (300a,0079) vr=IS, vm=1, type=3
    bool getNumberOfFractionPatternDigitsPerDay(std::string& parameter) const;
    std::string getNumberOfFractionPatternDigitsPerDayTag() const { return "(300a,0079)"; }
    bool setNumberOfFractionPatternDigitsPerDay(std::string parameter);
    
    // NumberOfFractionsPlanned (300a,0078) vr=IS, vm=1, type=2
    bool getNumberOfFractionsPlanned(std::string& parameter) const;
    std::string getNumberOfFractionsPlannedTag() const { return "(300a,0078)"; }
    bool setNumberOfFractionsPlanned(std::string parameter);
    
    // RepeatFractionCycleLength (300a,007a) vr=IS, vm=1, type=3
    bool getRepeatFractionCycleLength(std::string& parameter) const;
    std::string getRepeatFractionCycleLengthTag() const { return "(300a,007a)"; }
    bool setRepeatFractionCycleLength(std::string parameter);
    
    // ReferencedBeamSequence (300c,0004) vr=SQ, vm=1, type=1C
    DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface getReferencedBeamSequence() const;
    std::string getReferencedBeamSequenceTag() const { return std::string("(300c,0004)"); }
    void setReferencedBeamSequence(DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface seq);
 
    // ReferencedBrachyApplicationSetupSequence (300c,000a) vr=SQ, vm=1, type=1C
    DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface getReferencedBrachyApplicationSetupSequence() const;
    std::string getReferencedBrachyApplicationSetupSequenceTag() const { return std::string("(300c,000a)"); }
    void setReferencedBrachyApplicationSetupSequence(DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface seq);
 
    // ReferencedDoseReferenceSequence (300c,0050) vr=SQ, vm=1, type=3
    DcmDRTReferencedDoseReferenceSequenceInRTFractionSchemeModuleInterface getReferencedDoseReferenceSequence() const;
    std::string getReferencedDoseReferenceSequenceTag() const { return std::string("(300c,0050)"); }
    void setReferencedDoseReferenceSequence(DcmDRTReferencedDoseReferenceSequenceInRTFractionSchemeModuleInterface seq);
 
    // ReferencedDoseSequence (300c,0080) vr=SQ, vm=1, type=3
    DcmDRTReferencedDoseSequenceInterface getReferencedDoseSequence() const;
    std::string getReferencedDoseSequenceTag() const { return std::string("(300c,0080)"); }
    void setReferencedDoseSequence(DcmDRTReferencedDoseSequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTFractionGroupSequenceInterface()  { }
    
    DcmDRTFractionGroupSequenceInterface(std::vector<DcmDRTFractionGroupSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTFractionGroupSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTFractionGroupSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTFractionGroupSequenceInterface() {} 
    // FractionGroupDescription (300a,0072) vr=LO, vm=1, type=3
    bool getFractionGroupDescription(unsigned long idx, std::string& parameter) const;
    bool getFractionGroupDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFractionGroupDescriptionTag() const { return "(300a,0072)"; }
    bool setFractionGroupDescription(unsigned long idx, std::string parameter);
    
    // FractionGroupNumber (300a,0071) vr=IS, vm=1, type=1
    bool getFractionGroupNumber(unsigned long idx, std::string& parameter) const;
    bool getFractionGroupNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFractionGroupNumberTag() const { return "(300a,0071)"; }
    bool setFractionGroupNumber(unsigned long idx, std::string parameter);
    
    // FractionPattern (300a,007b) vr=LT, vm=1, type=3
    bool getFractionPattern(unsigned long idx, std::string& parameter) const;
    bool getFractionPattern(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFractionPatternTag() const { return "(300a,007b)"; }
    bool setFractionPattern(unsigned long idx, std::string parameter);
    
    // NumberOfBeams (300a,0080) vr=IS, vm=1, type=1
    bool getNumberOfBeams(unsigned long idx, std::string& parameter) const;
    bool getNumberOfBeams(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNumberOfBeamsTag() const { return "(300a,0080)"; }
    bool setNumberOfBeams(unsigned long idx, std::string parameter);
    
    // NumberOfBrachyApplicationSetups (300a,00a0) vr=IS, vm=1, type=1
    bool getNumberOfBrachyApplicationSetups(unsigned long idx, std::string& parameter) const;
    bool getNumberOfBrachyApplicationSetups(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNumberOfBrachyApplicationSetupsTag() const { return "(300a,00a0)"; }
    bool setNumberOfBrachyApplicationSetups(unsigned long idx, std::string parameter);
    
    // NumberOfFractionPatternDigitsPerDay (300a,0079) vr=IS, vm=1, type=3
    bool getNumberOfFractionPatternDigitsPerDay(unsigned long idx, std::string& parameter) const;
    bool getNumberOfFractionPatternDigitsPerDay(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNumberOfFractionPatternDigitsPerDayTag() const { return "(300a,0079)"; }
    bool setNumberOfFractionPatternDigitsPerDay(unsigned long idx, std::string parameter);
    
    // NumberOfFractionsPlanned (300a,0078) vr=IS, vm=1, type=2
    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);
    
    // RepeatFractionCycleLength (300a,007a) vr=IS, vm=1, type=3
    bool getRepeatFractionCycleLength(unsigned long idx, std::string& parameter) const;
    bool getRepeatFractionCycleLength(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getRepeatFractionCycleLengthTag() const { return "(300a,007a)"; }
    bool setRepeatFractionCycleLength(unsigned long idx, std::string parameter);
     
    // ReferencedBeamSequence (300c,0004) vr=SQ, vm=1, type=1C
    DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface getReferencedBeamSequence(unsigned long idx) const;
    std::string getReferencedBeamSequenceTag() const { return std::string("(300c,0004)"); }
    void setReferencedBeamSequence(DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface seq, unsigned long idx);
 
    // ReferencedBrachyApplicationSetupSequence (300c,000a) vr=SQ, vm=1, type=1C
    DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface getReferencedBrachyApplicationSetupSequence(unsigned long idx) const;
    std::string getReferencedBrachyApplicationSetupSequenceTag() const { return std::string("(300c,000a)"); }
    void setReferencedBrachyApplicationSetupSequence(DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface seq, unsigned long idx);
 
    // ReferencedDoseReferenceSequence (300c,0050) vr=SQ, vm=1, type=3
    DcmDRTReferencedDoseReferenceSequenceInRTFractionSchemeModuleInterface getReferencedDoseReferenceSequence(unsigned long idx) const;
    std::string getReferencedDoseReferenceSequenceTag() const { return std::string("(300c,0050)"); }
    void setReferencedDoseReferenceSequence(DcmDRTReferencedDoseReferenceSequenceInRTFractionSchemeModuleInterface seq, unsigned long idx);
 
    // ReferencedDoseSequence (300c,0080) vr=SQ, vm=1, type=3
    DcmDRTReferencedDoseSequenceInterface getReferencedDoseSequence(unsigned long idx) const;
    std::string getReferencedDoseSequenceTag() const { return std::string("(300c,0080)"); }
    void setReferencedDoseSequence(DcmDRTReferencedDoseSequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTFractionGroupSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTFractionGroupSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTFractionGroupSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTFractionGroupSequenceInterface::Item();
    }
    
    DcmDRTFractionGroupSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTFractionGroupSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTFractionGroupSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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