expert_container.hpp

Go to the documentation of this file.

//
// Copyright 2016 Ettus Research
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#pragma once

#include <uhd/config.hpp>
#include <uhd/experts/expert_nodes.hpp>
#include <uhd/utils/noncopyable.hpp>
#include <memory>
#include <mutex>

namespace uhd { namespace experts {

enum auto_resolve_mode_t {
    AUTO_RESOLVE_OFF,
    AUTO_RESOLVE_ON_READ,
    AUTO_RESOLVE_ON_WRITE,
    AUTO_RESOLVE_ON_READ_WRITE
};

class UHD_API expert_container : private uhd::noncopyable, public node_retriever_t
{
public: // Methods
    typedef std::shared_ptr<expert_container> sptr;

    ~expert_container() override{};

    virtual const std::string& get_name() const = 0;

    virtual void resolve_all(bool force = false) = 0;

    virtual void resolve_from(const std::string& node_name) = 0;

    virtual void resolve_to(const std::string& node_name) = 0;

    virtual const node_retriever_t& node_retriever() const = 0;

    virtual std::string to_dot() const = 0;

    virtual void debug_audit() const = 0;

private:
    const dag_vertex_t& lookup(const std::string& name) const override = 0;
    dag_vertex_t& retrieve(const std::string& name) const override     = 0;

    friend class expert_factory;

    static sptr make(const std::string& name);

    virtual std::recursive_mutex& resolve_mutex() = 0;

    virtual void add_data_node(
        dag_vertex_t* data_node, auto_resolve_mode_t resolve_mode = AUTO_RESOLVE_OFF) = 0;

    virtual void add_worker(worker_node_t* worker) = 0;

    virtual void clear() = 0;
};

}} // namespace uhd::experts