mlDcmDRTDoseReferenceSequenceInterface.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 __mlDcmDRTDoseReferenceSequenceInterface_H
#define __mlDcmDRTDoseReferenceSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTDoseReferenceSequenceInterface.h" //DRTDoseReferenceSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTDoseReferenceSequenceInterface
{
  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; }
 
      
    // ConstraintWeight (300a,0021) vr=DS, vm=1, type=3
    bool getConstraintWeight(std::string& parameter) const;
    std::string getConstraintWeightTag() const { return "(300a,0021)"; }
    bool setConstraintWeight(std::string parameter);
    
    // DeliveryMaximumDose (300a,0023) vr=DS, vm=1, type=3
    bool getDeliveryMaximumDose(std::string& parameter) const;
    std::string getDeliveryMaximumDoseTag() const { return "(300a,0023)"; }
    bool setDeliveryMaximumDose(std::string parameter);
    
    // DeliveryWarningDose (300a,0022) vr=DS, vm=1, type=3
    bool getDeliveryWarningDose(std::string& parameter) const;
    std::string getDeliveryWarningDoseTag() const { return "(300a,0022)"; }
    bool setDeliveryWarningDose(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);
    
    // DoseReferenceNumber (300a,0012) vr=IS, vm=1, type=1C
    bool getDoseReferenceNumber(std::string& parameter) const;
    std::string getDoseReferenceNumberTag() const { return "(300a,0012)"; }
    bool setDoseReferenceNumber(std::string parameter);
    
    // DoseReferencePointCoordinates (300a,0018) vr=DS, vm=3, type=1C
    bool getDoseReferencePointCoordinates(std::string& parameter) const;
    std::string getDoseReferencePointCoordinatesTag() const { return "(300a,0018)"; }
    bool setDoseReferencePointCoordinates(std::string parameter);
    
    // DoseReferenceStructureType (300a,0014) vr=CS, vm=1, type=1C
    bool getDoseReferenceStructureType(std::string& parameter) const;
    std::string getDoseReferenceStructureTypeTag() const { return "(300a,0014)"; }
    bool setDoseReferenceStructureType(std::string parameter);
    
    // DoseReferenceType (300a,0020) vr=CS, vm=1, type=1C
    bool getDoseReferenceType(std::string& parameter) const;
    std::string getDoseReferenceTypeTag() const { return "(300a,0020)"; }
    bool setDoseReferenceType(std::string parameter);
    
    // DoseReferenceUID (300a,0013) vr=UI, vm=1, type=3
    bool getDoseReferenceUID(std::string& parameter) const;
    std::string getDoseReferenceUIDTag() const { return "(300a,0013)"; }
    bool setDoseReferenceUID(std::string parameter);
    
    // NominalPriorDose (300a,001a) vr=DS, vm=1, type=3
    bool getNominalPriorDose(std::string& parameter) const;
    std::string getNominalPriorDoseTag() const { return "(300a,001a)"; }
    bool setNominalPriorDose(std::string parameter);
    
    // OrganAtRiskFullVolumeDose (300a,002a) vr=DS, vm=1, type=3
    bool getOrganAtRiskFullVolumeDose(std::string& parameter) const;
    std::string getOrganAtRiskFullVolumeDoseTag() const { return "(300a,002a)"; }
    bool setOrganAtRiskFullVolumeDose(std::string parameter);
    
    // OrganAtRiskLimitDose (300a,002b) vr=DS, vm=1, type=3
    bool getOrganAtRiskLimitDose(std::string& parameter) const;
    std::string getOrganAtRiskLimitDoseTag() const { return "(300a,002b)"; }
    bool setOrganAtRiskLimitDose(std::string parameter);
    
    // OrganAtRiskMaximumDose (300a,002c) vr=DS, vm=1, type=3
    bool getOrganAtRiskMaximumDose(std::string& parameter) const;
    std::string getOrganAtRiskMaximumDoseTag() const { return "(300a,002c)"; }
    bool setOrganAtRiskMaximumDose(std::string parameter);
    
    // OrganAtRiskOverdoseVolumeFraction (300a,002d) vr=DS, vm=1, type=3
    bool getOrganAtRiskOverdoseVolumeFraction(std::string& parameter) const;
    std::string getOrganAtRiskOverdoseVolumeFractionTag() const { return "(300a,002d)"; }
    bool setOrganAtRiskOverdoseVolumeFraction(std::string parameter);
    
    // ReferencedROINumber (3006,0084) vr=IS, vm=1, type=1C
    bool getReferencedROINumber(std::string& parameter) const;
    std::string getReferencedROINumberTag() const { return "(3006,0084)"; }
    bool setReferencedROINumber(std::string parameter);
    
    // TargetMaximumDose (300a,0027) vr=DS, vm=1, type=3
    bool getTargetMaximumDose(std::string& parameter) const;
    std::string getTargetMaximumDoseTag() const { return "(300a,0027)"; }
    bool setTargetMaximumDose(std::string parameter);
    
    // TargetMinimumDose (300a,0025) vr=DS, vm=1, type=3
    bool getTargetMinimumDose(std::string& parameter) const;
    std::string getTargetMinimumDoseTag() const { return "(300a,0025)"; }
    bool setTargetMinimumDose(std::string parameter);
    
    // TargetPrescriptionDose (300a,0026) vr=DS, vm=1, type=3
    bool getTargetPrescriptionDose(std::string& parameter) const;
    std::string getTargetPrescriptionDoseTag() const { return "(300a,0026)"; }
    bool setTargetPrescriptionDose(std::string parameter);
    
    // TargetUnderdoseVolumeFraction (300a,0028) vr=DS, vm=1, type=3
    bool getTargetUnderdoseVolumeFraction(std::string& parameter) const;
    std::string getTargetUnderdoseVolumeFractionTag() const { return "(300a,0028)"; }
    bool setTargetUnderdoseVolumeFraction(std::string parameter);
    
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTDoseReferenceSequenceInterface()  { }
    
    DcmDRTDoseReferenceSequenceInterface(std::vector<DcmDRTDoseReferenceSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTDoseReferenceSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTDoseReferenceSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTDoseReferenceSequenceInterface() {} 
    // ConstraintWeight (300a,0021) vr=DS, vm=1, type=3
    bool getConstraintWeight(unsigned long idx, std::string& parameter) const;
    bool getConstraintWeight(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getConstraintWeightTag() const { return "(300a,0021)"; }
    bool setConstraintWeight(unsigned long idx, std::string parameter);
    
    // DeliveryMaximumDose (300a,0023) vr=DS, vm=1, type=3
    bool getDeliveryMaximumDose(unsigned long idx, std::string& parameter) const;
    bool getDeliveryMaximumDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDeliveryMaximumDoseTag() const { return "(300a,0023)"; }
    bool setDeliveryMaximumDose(unsigned long idx, std::string parameter);
    
    // DeliveryWarningDose (300a,0022) vr=DS, vm=1, type=3
    bool getDeliveryWarningDose(unsigned long idx, std::string& parameter) const;
    bool getDeliveryWarningDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDeliveryWarningDoseTag() const { return "(300a,0022)"; }
    bool setDeliveryWarningDose(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);
    
    // DoseReferenceNumber (300a,0012) vr=IS, vm=1, type=1C
    bool getDoseReferenceNumber(unsigned long idx, std::string& parameter) const;
    bool getDoseReferenceNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDoseReferenceNumberTag() const { return "(300a,0012)"; }
    bool setDoseReferenceNumber(unsigned long idx, std::string parameter);
    
    // DoseReferencePointCoordinates (300a,0018) vr=DS, vm=3, type=1C
    bool getDoseReferencePointCoordinates(unsigned long idx, std::string& parameter) const;
    bool getDoseReferencePointCoordinates(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDoseReferencePointCoordinatesTag() const { return "(300a,0018)"; }
    bool setDoseReferencePointCoordinates(unsigned long idx, std::string parameter);
    
    // DoseReferenceStructureType (300a,0014) vr=CS, vm=1, type=1C
    bool getDoseReferenceStructureType(unsigned long idx, std::string& parameter) const;
    bool getDoseReferenceStructureType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDoseReferenceStructureTypeTag() const { return "(300a,0014)"; }
    bool setDoseReferenceStructureType(unsigned long idx, std::string parameter);
    
    // DoseReferenceType (300a,0020) vr=CS, vm=1, type=1C
    bool getDoseReferenceType(unsigned long idx, std::string& parameter) const;
    bool getDoseReferenceType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDoseReferenceTypeTag() const { return "(300a,0020)"; }
    bool setDoseReferenceType(unsigned long idx, std::string parameter);
    
    // DoseReferenceUID (300a,0013) vr=UI, vm=1, type=3
    bool getDoseReferenceUID(unsigned long idx, std::string& parameter) const;
    bool getDoseReferenceUID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDoseReferenceUIDTag() const { return "(300a,0013)"; }
    bool setDoseReferenceUID(unsigned long idx, std::string parameter);
    
    // NominalPriorDose (300a,001a) vr=DS, vm=1, type=3
    bool getNominalPriorDose(unsigned long idx, std::string& parameter) const;
    bool getNominalPriorDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNominalPriorDoseTag() const { return "(300a,001a)"; }
    bool setNominalPriorDose(unsigned long idx, std::string parameter);
    
    // OrganAtRiskFullVolumeDose (300a,002a) vr=DS, vm=1, type=3
    bool getOrganAtRiskFullVolumeDose(unsigned long idx, std::string& parameter) const;
    bool getOrganAtRiskFullVolumeDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getOrganAtRiskFullVolumeDoseTag() const { return "(300a,002a)"; }
    bool setOrganAtRiskFullVolumeDose(unsigned long idx, std::string parameter);
    
    // OrganAtRiskLimitDose (300a,002b) vr=DS, vm=1, type=3
    bool getOrganAtRiskLimitDose(unsigned long idx, std::string& parameter) const;
    bool getOrganAtRiskLimitDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getOrganAtRiskLimitDoseTag() const { return "(300a,002b)"; }
    bool setOrganAtRiskLimitDose(unsigned long idx, std::string parameter);
    
    // OrganAtRiskMaximumDose (300a,002c) vr=DS, vm=1, type=3
    bool getOrganAtRiskMaximumDose(unsigned long idx, std::string& parameter) const;
    bool getOrganAtRiskMaximumDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getOrganAtRiskMaximumDoseTag() const { return "(300a,002c)"; }
    bool setOrganAtRiskMaximumDose(unsigned long idx, std::string parameter);
    
    // OrganAtRiskOverdoseVolumeFraction (300a,002d) vr=DS, vm=1, type=3
    bool getOrganAtRiskOverdoseVolumeFraction(unsigned long idx, std::string& parameter) const;
    bool getOrganAtRiskOverdoseVolumeFraction(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getOrganAtRiskOverdoseVolumeFractionTag() const { return "(300a,002d)"; }
    bool setOrganAtRiskOverdoseVolumeFraction(unsigned long idx, std::string parameter);
    
    // ReferencedROINumber (3006,0084) vr=IS, vm=1, type=1C
    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);
    
    // TargetMaximumDose (300a,0027) vr=DS, vm=1, type=3
    bool getTargetMaximumDose(unsigned long idx, std::string& parameter) const;
    bool getTargetMaximumDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTargetMaximumDoseTag() const { return "(300a,0027)"; }
    bool setTargetMaximumDose(unsigned long idx, std::string parameter);
    
    // TargetMinimumDose (300a,0025) vr=DS, vm=1, type=3
    bool getTargetMinimumDose(unsigned long idx, std::string& parameter) const;
    bool getTargetMinimumDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTargetMinimumDoseTag() const { return "(300a,0025)"; }
    bool setTargetMinimumDose(unsigned long idx, std::string parameter);
    
    // TargetPrescriptionDose (300a,0026) vr=DS, vm=1, type=3
    bool getTargetPrescriptionDose(unsigned long idx, std::string& parameter) const;
    bool getTargetPrescriptionDose(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTargetPrescriptionDoseTag() const { return "(300a,0026)"; }
    bool setTargetPrescriptionDose(unsigned long idx, std::string parameter);
    
    // TargetUnderdoseVolumeFraction (300a,0028) vr=DS, vm=1, type=3
    bool getTargetUnderdoseVolumeFraction(unsigned long idx, std::string& parameter) const;
    bool getTargetUnderdoseVolumeFraction(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTargetUnderdoseVolumeFractionTag() const { return "(300a,0028)"; }
    bool setTargetUnderdoseVolumeFraction(unsigned long idx, std::string parameter);
     
    
    void setSequence(std::vector<DcmDRTDoseReferenceSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTDoseReferenceSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTDoseReferenceSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTDoseReferenceSequenceInterface::Item();
    }
    
    DcmDRTDoseReferenceSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTDoseReferenceSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTDoseReferenceSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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