MuxedInterruptDistributor.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 "../VersionNumber.h"
 
#include <boost/enable_shared_from_this.hpp>
#include <boost/shared_ptr.hpp>
 
#include <functional>
#include <map>
#include <memory>
#include <vector>
 
namespace ChimeraTK {
  class DeviceBackend;
} // namespace ChimeraTK
 
namespace ChimeraTK::async {
  class MuxedInterruptDistributor;
  class AsyncAccessorManager;
  template<typename BackendSpecificDataType>
  class SubDomain;
  class Domain;
 
  /********************************************************************************************************************/
 
  class MuxedInterruptDistributorFactory {
   public:
    static MuxedInterruptDistributorFactory& getInstance();
    boost::shared_ptr<MuxedInterruptDistributor> createMuxedInterruptDistributor(
        boost::shared_ptr<SubDomain<std::nullptr_t>> parent);
 
   protected:
    std::map<std::string,
        std::function<std::unique_ptr<MuxedInterruptDistributor>(
            std::string, boost::shared_ptr<SubDomain<std::nullptr_t>>)>>
        _creatorFunctions;
    static std::unique_ptr<MuxedInterruptDistributorFactory> _instance;
 
    static std::pair<std::string, std::string> getInterruptControllerNameAndDescriptionFromCatalogue(
        std::vector<size_t> const& subdomainID, DeviceBackend& backend);
 
   private:
    MuxedInterruptDistributorFactory();
  };
 
  /********************************************************************************************************************/
 
  class MuxedInterruptDistributor : public boost::enable_shared_from_this<MuxedInterruptDistributor> {
   public:
    explicit MuxedInterruptDistributor(boost::shared_ptr<SubDomain<std::nullptr_t>> parent);
    virtual ~MuxedInterruptDistributor() = default;
 
    template<typename DistributorType>
    [[nodiscard]] boost::shared_ptr<AsyncAccessorManager> getAccessorManager(
        std::vector<size_t> const& qualififedSubDomainId);
 
    virtual void activate(VersionNumber version);
    void sendException(const std::exception_ptr& e);
 
    virtual void handle(VersionNumber version) = 0;
 
   protected:
    std::map<size_t, boost::weak_ptr<SubDomain<std::nullptr_t>>> _subDomains;
 
    boost::shared_ptr<DeviceBackend> _backend;
 
    std::vector<size_t> _id;
 
    boost::shared_ptr<SubDomain<std::nullptr_t>> _parent;
    boost::shared_ptr<Domain> _asyncDomain;
 
    virtual void activateSubDomain(SubDomain<std::nullptr_t>& subDomain, VersionNumber const& version);
  };
 
  /********************************************************************************************************************/
 
} // namespace ChimeraTK::async