Utilities.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 "DeviceInfoMap.h"
#include "Exception.h"
 
#include <list>
#include <map>
 
namespace ChimeraTK {
 
  std::string getDMapFilePath();
 
  void setDMapFilePath(std::string dmapFilePath);
 
  struct DeviceDescriptor {
    std::string backendType;
    std::string address;
    std::map<std::string, std::string> parameters;
  };
 
  struct Sdm {
    double sdmVersion{0.1};
    std::string host;
    std::string interface;
    std::string instance;
    std::string protocol;
    std::list<std::string> parameters;
  };
 
  namespace Utilities {
 
    DeviceDescriptor parseDeviceDesciptor(std::string cddString);
 
    bool isDeviceDescriptor(std::string theString);
 
    Sdm parseSdm(const std::string& sdmString);
 
    Sdm parseDeviceString(const std::string& deviceString);
 
    std::size_t shmDummyInstanceIdHash(
        const std::string& address, const std::map<std::string, std::string>& parameters);
 
    std::string createShmName(std::size_t instanceIdHash, const std::string& mapFileName, const std::string& userName);
 
    bool isSdm(const std::string& theString);
 
    size_t countOccurence(std::string theString, char delimiter);
 
    DeviceInfoMap::DeviceInfo aliasLookUp(const std::string& aliasName, const std::string& dmapFilePath);
 
    std::vector<std::string> getAliasList();
 
    void printStackTrace();
 
  } // namespace Utilities
 
} /* namespace ChimeraTK */