device.hpp

Go to the documentation of this file.

//
// Copyright 2010-2011,2014 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#ifndef INCLUDED_UHD_DEVICE_HPP
#define INCLUDED_UHD_DEVICE_HPP

#include <uhd/config.hpp>
#include <uhd/stream.hpp>
#include <uhd/deprecated.hpp>
#include <uhd/property_tree.hpp>
#include <uhd/types/device_addr.hpp>
#include <boost/utility.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>

namespace uhd{

class property_tree; //forward declaration

class UHD_API device : boost::noncopyable{

public:
    typedef boost::shared_ptr<device> sptr;
    typedef boost::function<device_addrs_t(const device_addr_t &)> find_t;
    typedef boost::function<sptr(const device_addr_t &)> make_t;

    enum device_filter_t {
        ANY,
        USRP,
        CLOCK
    };
    virtual ~device(void) = 0;

    static void register_device(
        const find_t &find,
        const make_t &make,
        const device_filter_t filter
    );

    static device_addrs_t find(const device_addr_t &hint, device_filter_t filter = ANY);

    static sptr make(const device_addr_t &hint, device_filter_t filter = ANY, size_t which = 0);

    virtual rx_streamer::sptr get_rx_stream(const stream_args_t &args) = 0;

    virtual tx_streamer::sptr get_tx_stream(const stream_args_t &args) = 0;

    virtual bool recv_async_msg(
        async_metadata_t &async_metadata, double timeout = 0.1
    ) = 0;

    uhd::property_tree::sptr get_tree(void) const;

    device_filter_t get_device_type() const;

protected:
    uhd::property_tree::sptr _tree;
    device_filter_t _type;
};

} //namespace uhd

#endif /* INCLUDED_UHD_DEVICE_HPP */