mlDcmDRTContributingEquipmentSequenceInterface.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 __mlDcmDRTContributingEquipmentSequenceInterface_H
#define __mlDcmDRTContributingEquipmentSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTContributingEquipmentSequenceInterface.h" //DRTContributingEquipmentSequence
#include "mlDcmDRTPurposeOfReferenceCodeSequenceInterface.h" //DRTPurposeOfReferenceCodeSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTContributingEquipmentSequenceInterface
{
  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; }
 
      
    // ContributionDateTime (0018,a002) vr=DT, vm=1, type=3
    bool getContributionDateTime(std::string& parameter) const;
    std::string getContributionDateTimeTag() const { return "(0018,a002)"; }
    bool setContributionDateTime(std::string parameter);
    
    // ContributionDescription (0018,a003) vr=ST, vm=1, type=3
    bool getContributionDescription(std::string& parameter) const;
    std::string getContributionDescriptionTag() const { return "(0018,a003)"; }
    bool setContributionDescription(std::string parameter);
    
    // DateOfLastCalibration (0018,1200) vr=DA, vm=1-n, type=3
    bool getDateOfLastCalibration(std::string& parameter) const;
    std::string getDateOfLastCalibrationTag() const { return "(0018,1200)"; }
    bool setDateOfLastCalibration(std::string parameter);
    
    // DeviceSerialNumber (0018,1000) vr=LO, vm=1, type=3
    bool getDeviceSerialNumber(std::string& parameter) const;
    std::string getDeviceSerialNumberTag() const { return "(0018,1000)"; }
    bool setDeviceSerialNumber(std::string parameter);
    
    // InstitutionAddress (0008,0081) vr=ST, vm=1, type=3
    bool getInstitutionAddress(std::string& parameter) const;
    std::string getInstitutionAddressTag() const { return "(0008,0081)"; }
    bool setInstitutionAddress(std::string parameter);
    
    // InstitutionName (0008,0080) vr=LO, vm=1, type=3
    bool getInstitutionName(std::string& parameter) const;
    std::string getInstitutionNameTag() const { return "(0008,0080)"; }
    bool setInstitutionName(std::string parameter);
    
    // InstitutionalDepartmentName (0008,1040) vr=LO, vm=1, type=3
    bool getInstitutionalDepartmentName(std::string& parameter) const;
    std::string getInstitutionalDepartmentNameTag() const { return "(0008,1040)"; }
    bool setInstitutionalDepartmentName(std::string parameter);
    
    // Manufacturer (0008,0070) vr=LO, vm=1, type=1
    bool getManufacturer(std::string& parameter) const;
    std::string getManufacturerTag() const { return "(0008,0070)"; }
    bool setManufacturer(std::string parameter);
    
    // ManufacturerModelName (0008,1090) vr=LO, vm=1, type=3
    bool getManufacturerModelName(std::string& parameter) const;
    std::string getManufacturerModelNameTag() const { return "(0008,1090)"; }
    bool setManufacturerModelName(std::string parameter);
    
    // SoftwareVersions (0018,1020) vr=LO, vm=1-n, type=3
    bool getSoftwareVersions(std::string& parameter) const;
    std::string getSoftwareVersionsTag() const { return "(0018,1020)"; }
    bool setSoftwareVersions(std::string parameter);
    
    // SpatialResolution (0018,1050) vr=DS, vm=1, type=3
    bool getSpatialResolution(std::string& parameter) const;
    std::string getSpatialResolutionTag() const { return "(0018,1050)"; }
    bool setSpatialResolution(std::string parameter);
    
    // StationName (0008,1010) vr=SH, vm=1, type=3
    bool getStationName(std::string& parameter) const;
    std::string getStationNameTag() const { return "(0008,1010)"; }
    bool setStationName(std::string parameter);
    
    // TimeOfLastCalibration (0018,1201) vr=TM, vm=1-n, type=3
    bool getTimeOfLastCalibration(std::string& parameter) const;
    std::string getTimeOfLastCalibrationTag() const { return "(0018,1201)"; }
    bool setTimeOfLastCalibration(std::string parameter);
    
    // PurposeOfReferenceCodeSequence (0040,a170) vr=SQ, vm=1, type=1
    DcmDRTPurposeOfReferenceCodeSequenceInterface getPurposeOfReferenceCodeSequence() const;
    std::string getPurposeOfReferenceCodeSequenceTag() const { return std::string("(0040,a170)"); }
    void setPurposeOfReferenceCodeSequence(DcmDRTPurposeOfReferenceCodeSequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTContributingEquipmentSequenceInterface()  { }
    
    DcmDRTContributingEquipmentSequenceInterface(std::vector<DcmDRTContributingEquipmentSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTContributingEquipmentSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTContributingEquipmentSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTContributingEquipmentSequenceInterface() {} 
    // ContributionDateTime (0018,a002) vr=DT, vm=1, type=3
    bool getContributionDateTime(unsigned long idx, std::string& parameter) const;
    bool getContributionDateTime(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getContributionDateTimeTag() const { return "(0018,a002)"; }
    bool setContributionDateTime(unsigned long idx, std::string parameter);
    
    // ContributionDescription (0018,a003) vr=ST, vm=1, type=3
    bool getContributionDescription(unsigned long idx, std::string& parameter) const;
    bool getContributionDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getContributionDescriptionTag() const { return "(0018,a003)"; }
    bool setContributionDescription(unsigned long idx, std::string parameter);
    
    // DateOfLastCalibration (0018,1200) vr=DA, vm=1-n, type=3
    bool getDateOfLastCalibration(unsigned long idx, std::string& parameter) const;
    bool getDateOfLastCalibration(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDateOfLastCalibrationTag() const { return "(0018,1200)"; }
    bool setDateOfLastCalibration(unsigned long idx, std::string parameter);
    
    // DeviceSerialNumber (0018,1000) vr=LO, vm=1, type=3
    bool getDeviceSerialNumber(unsigned long idx, std::string& parameter) const;
    bool getDeviceSerialNumber(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDeviceSerialNumberTag() const { return "(0018,1000)"; }
    bool setDeviceSerialNumber(unsigned long idx, std::string parameter);
    
    // InstitutionAddress (0008,0081) vr=ST, vm=1, type=3
    bool getInstitutionAddress(unsigned long idx, std::string& parameter) const;
    bool getInstitutionAddress(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getInstitutionAddressTag() const { return "(0008,0081)"; }
    bool setInstitutionAddress(unsigned long idx, std::string parameter);
    
    // InstitutionName (0008,0080) vr=LO, vm=1, type=3
    bool getInstitutionName(unsigned long idx, std::string& parameter) const;
    bool getInstitutionName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getInstitutionNameTag() const { return "(0008,0080)"; }
    bool setInstitutionName(unsigned long idx, std::string parameter);
    
    // InstitutionalDepartmentName (0008,1040) vr=LO, vm=1, type=3
    bool getInstitutionalDepartmentName(unsigned long idx, std::string& parameter) const;
    bool getInstitutionalDepartmentName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getInstitutionalDepartmentNameTag() const { return "(0008,1040)"; }
    bool setInstitutionalDepartmentName(unsigned long idx, std::string parameter);
    
    // Manufacturer (0008,0070) vr=LO, vm=1, type=1
    bool getManufacturer(unsigned long idx, std::string& parameter) const;
    bool getManufacturer(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getManufacturerTag() const { return "(0008,0070)"; }
    bool setManufacturer(unsigned long idx, std::string parameter);
    
    // ManufacturerModelName (0008,1090) vr=LO, vm=1, type=3
    bool getManufacturerModelName(unsigned long idx, std::string& parameter) const;
    bool getManufacturerModelName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getManufacturerModelNameTag() const { return "(0008,1090)"; }
    bool setManufacturerModelName(unsigned long idx, std::string parameter);
    
    // SoftwareVersions (0018,1020) vr=LO, vm=1-n, type=3
    bool getSoftwareVersions(unsigned long idx, std::string& parameter) const;
    bool getSoftwareVersions(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSoftwareVersionsTag() const { return "(0018,1020)"; }
    bool setSoftwareVersions(unsigned long idx, std::string parameter);
    
    // SpatialResolution (0018,1050) vr=DS, vm=1, type=3
    bool getSpatialResolution(unsigned long idx, std::string& parameter) const;
    bool getSpatialResolution(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getSpatialResolutionTag() const { return "(0018,1050)"; }
    bool setSpatialResolution(unsigned long idx, std::string parameter);
    
    // StationName (0008,1010) vr=SH, vm=1, type=3
    bool getStationName(unsigned long idx, std::string& parameter) const;
    bool getStationName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getStationNameTag() const { return "(0008,1010)"; }
    bool setStationName(unsigned long idx, std::string parameter);
    
    // TimeOfLastCalibration (0018,1201) vr=TM, vm=1-n, type=3
    bool getTimeOfLastCalibration(unsigned long idx, std::string& parameter) const;
    bool getTimeOfLastCalibration(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTimeOfLastCalibrationTag() const { return "(0018,1201)"; }
    bool setTimeOfLastCalibration(unsigned long idx, std::string parameter);
     
    // PurposeOfReferenceCodeSequence (0040,a170) vr=SQ, vm=1, type=1
    DcmDRTPurposeOfReferenceCodeSequenceInterface getPurposeOfReferenceCodeSequence(unsigned long idx) const;
    std::string getPurposeOfReferenceCodeSequenceTag() const { return std::string("(0040,a170)"); }
    void setPurposeOfReferenceCodeSequence(DcmDRTPurposeOfReferenceCodeSequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTContributingEquipmentSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTContributingEquipmentSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTContributingEquipmentSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTContributingEquipmentSequenceInterface::Item();
    }
    
    DcmDRTContributingEquipmentSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTContributingEquipmentSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTContributingEquipmentSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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