DeviceBackend.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 "AccessMode.h"
#include "Exception.h"
#include "ForwardDeclarations.h"
#include "MetadataCatalogue.h"
#include "RegisterCatalogue.h"
#include "VersionNumber.h"
#include "VirtualFunctionTemplate.h"
 
#include <boost/enable_shared_from_this.hpp>
 
#include <cstdint>
#include <string>
 
namespace ChimeraTK {
  namespace async {
    class MuxedInterruptDistributor;
    template<typename BackendSpecificDataType>
    class SubDomain;
  } // namespace async
 
  namespace detail {
    class SharedAccessors;
  } // namespace detail
 
  class DeviceBackend : public boost::enable_shared_from_this<DeviceBackend> {
   public:
    virtual ~DeviceBackend() = default;
 
    virtual void open() = 0;
 
    virtual void close() = 0;
 
    virtual bool isOpen() = 0;
 
    [[deprecated]] virtual bool isConnected() = 0;
 
    virtual bool isFunctional() const noexcept = 0;
 
    virtual RegisterCatalogue getRegisterCatalogue() const = 0;
 
    virtual MetadataCatalogue getMetadataCatalogue() const = 0;
 
    template<typename UserType>
    boost::shared_ptr<NDRegisterAccessor<UserType>> getRegisterAccessor(
        const RegisterPath& registerPathName, size_t numberOfWords, size_t wordOffsetInRegister, AccessModeFlags flags);
    DEFINE_VIRTUAL_FUNCTION_TEMPLATE_VTABLE(getRegisterAccessor_impl,
        boost::shared_ptr<NDRegisterAccessor<T>>(const RegisterPath&, size_t, size_t, AccessModeFlags));
 
    virtual std::string readDeviceInfo() = 0;
 
    virtual void setException(const std::string& message) noexcept = 0;
 
    virtual void activateAsyncRead() noexcept {}
 
    virtual void checkActiveException() = 0;
 
    using BackendID = std::uintptr_t;
 
    BackendID getBackendID() {
      return reinterpret_cast<DeviceBackend::BackendID>(this); // NOLINT cppcoreguidelines-pro-type-reinterpret-cast
    }
 
    virtual std::set<BackendID> getInvolvedBackendIDs() = 0;
 
    virtual ChimeraTK::VersionNumber getVersionOnOpen() const = 0;
 
    virtual boost::shared_ptr<detail::SharedAccessors> getSharedAccessors() = 0;
  };
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  boost::shared_ptr<NDRegisterAccessor<UserType>> DeviceBackend::getRegisterAccessor(
      const RegisterPath& registerPathName, size_t numberOfWords, size_t wordOffsetInRegister, AccessModeFlags flags) {
    return CALL_VIRTUAL_FUNCTION_TEMPLATE(
        getRegisterAccessor_impl, UserType, registerPathName, numberOfWords, wordOffsetInRegister, flags);
  }
 
  /********************************************************************************************************************/
 
} // namespace ChimeraTK