DeviceModule.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 "ModuleGroup.h"
 
#include <ChimeraTK/Device.h>
#include <ChimeraTK/ForwardDeclarations.h>
#include <ChimeraTK/RegisterPath.h>
 
#include <boost/thread/latch.hpp>
 
namespace ChimeraTK {
  class DeviceManager;
 
  /********************************************************************************************************************/
 
  class DeviceModule : public ModuleGroup {
   public:
    DeviceModule(ModuleGroup* owner, const std::string& deviceAliasOrCDD, const std::string& triggerPath = {},
        std::function<void(ChimeraTK::Device&)> initialisationHandler = nullptr, const std::string& pathInDevice = "/");
 
    using ModuleGroup::ModuleGroup;
 
    DeviceModule(DeviceModule&& other) noexcept { operator=(std::move(other)); }
 
    DeviceModule& operator=(DeviceModule&& other) noexcept;
 
    DeviceManager& getDeviceManager();
    const DeviceManager& getDeviceManager() const;
 
    Model::DeviceModuleProxy getModel();
 
    const std::string& getDeviceAliasOrURI() const;
 
    void addInitialisationHandler(std::function<void(ChimeraTK::Device&)> initialisationHandler);
 
    void reportException(std::string errMsg);
 
    const std::string& getTriggerPath() const { return _triggerPath; }
 
   protected:
    boost::weak_ptr<DeviceManager> _dm;
 
    Model::DeviceModuleProxy _model;
    friend class ChimeraTK::Model::Impl;
 
    std::string _triggerPath;
 
    std::string _pathInDevice;
  };
 
  /********************************************************************************************************************/
 
  class SetDMapFilePath {
   public:
    explicit SetDMapFilePath(const std::string& dmapFilePath);
  };
 
  /********************************************************************************************************************/
 
} /* namespace ChimeraTK */