CircularDependencyDetector.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 "Module.h"
#include "VariableNetworkNode.h"
 
#include <boost/noncopyable.hpp>
#include <boost/thread.hpp>
 
#include <map>
#include <ostream>
#include <unordered_set>
 
namespace ChimeraTK::detail {
 
  struct CircularDependencyDetector : boost::noncopyable {
    CircularDependencyDetector() = default;
    ~CircularDependencyDetector();
 
    void registerDependencyWait(VariableNetworkNode& node);
 
    void unregisterDependencyWait(VariableNetworkNode& node);
 
    void printWaiters(std::ostream& stream = std::cout);
 
    void terminate();
 
    void startDetectBlockedModules();
 
    void detectBlockedModules();
 
   protected:
    std::mutex _mutex;
    std::map<Module*, Module*> _waitMap;
    std::map<Module*, std::string> _awaitedVariables;
    std::map<EntityOwner*, VariableNetworkNode> _awaitedNodes;
    std::unordered_set<Module*> _modulesWeHaveWarnedAbout;
    std::unordered_set<std::string> _devicesWeHaveWarnedAbout;
    std::unordered_set<NodeType> _otherThingsWeHaveWarnedAbout;
    boost::thread _thread;
 
   private:
  };
} // namespace ChimeraTK::detail