DeviceInfoMap.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Deutsches Elektronen-Synchrotron DESY, MSK, ChimeraTK Project <chimeratk-support@desy.de>
// SPDX-License-Identifier: LGPL-3.0-or-later
#pragma once
 
#include <boost/shared_ptr.hpp>
 
#include <cstdint>
#include <iostream>
#include <list>
#include <string>
#include <vector>
 
namespace ChimeraTK {
 
  class DeviceInfoMap {
   public:
    class DeviceInfo {
     public:
      std::string deviceName;      
      std::string uri;             
      std::string mapFileName;     
      std::string dmapFileName;    
      uint32_t dmapFileLineNumber; 
      DeviceInfo();
 
      [[nodiscard]] std::pair<std::string, std::string> getDeviceFileAndMapFileName() const;
 
      friend std::ostream& operator<<(std::ostream& os, const DeviceInfo& deviceInfo);
    };
 
    using iterator = std::vector<DeviceInfo>::iterator;
    using const_iterator = std::vector<DeviceInfo>::const_iterator;
    class ErrorList {
      friend class DeviceInfoMap;
 
     public:
      class ErrorElem {
       public:
        enum DMAP_FILE_ERR {
          NONUNIQUE_DEVICE_NAME 
        };
 
        enum class TYPE {
          ERROR,  
          WARNING 
        };
        using TYPE::ERROR;
        using TYPE::WARNING;
        DeviceInfoMap::DeviceInfo _errorDevice1; 
        DeviceInfoMap::DeviceInfo _errorDevice2; 
        DMAP_FILE_ERR _errorType;                
        TYPE _type;                              
        ErrorElem(TYPE infoType, DMAP_FILE_ERR errorType, const DeviceInfoMap::DeviceInfo& device1,
            const DeviceInfoMap::DeviceInfo& device2);
        friend std::ostream& operator<<(std::ostream& os, const TYPE& me);
        friend std::ostream& operator<<(std::ostream& os, const ErrorElem& me);
      };
      std::list<ErrorElem> _errors; 
      friend std::ostream& operator<<(std::ostream& os, const ErrorList& me);
 
     private:
      void clear();
      void insert(const ErrorElem& elem);
    };
    bool check(ErrorList& err, ErrorList::ErrorElem::TYPE level);
 
    friend std::ostream& operator<<(std::ostream& os, const DeviceInfoMap& deviceInfoMap);
    void getDeviceInfo(const std::string& deviceName, DeviceInfo& value);
    size_t getSize();
    iterator begin();
    [[nodiscard]] const_iterator begin() const;
    iterator end();
    [[nodiscard]] const_iterator end() const;
 
    std::vector<std::string> getPluginLibraries();
 
    void addPluginLibrary(const std::string& soFile);
 
   protected:
    std::vector<DeviceInfo> _deviceInfoElements; 
    std::string _dmapFileName;                   
    std::vector<std::string> _pluginLibraries;   
 
   public:
    explicit DeviceInfoMap(std::string fileName);
    void insert(const DeviceInfo& elem);
  };
  using DeviceInfoMapPointer = boost::shared_ptr<DeviceInfoMap>;
 
} // namespace ChimeraTK