aboutsummaryrefslogtreecommitdiffstats
path: root/include/osmosdr/osmosdr_device.h
blob: 330d0dff288250411c9f642d0e62639186467ef9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/* -*- c++ -*- */
/*
 * Copyright 2012 Dimitri Stolnikov <horiz0n@gmx.net>
 *
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_OSMOSDR_DEVICE_H
#define INCLUDED_OSMOSDR_DEVICE_H

#include <osmosdr_api.h>
#include <osmosdr_pimpl.h>
#include <boost/noncopyable.hpp>
#include <boost/lexical_cast.hpp>
#include <stdexcept>
#include <string>
#include <vector>
#include <map>

typedef std::map<std::string, std::string> string_string_dict_t;

namespace osmosdr {

  /*!
   * Mapping of key/value pairs for locating devices on the system.
   * When left empty, the device discovery routines will search
   * all available transports on the system (ethernet, usb...).
   *
   * The logical device can also be used to pass arguments into
   * the transport layer control to set (for example) buffer sizes.
   *
   * An arguments string, is a way to represent a device address
   * using a single string with delimiter characters.
   */
  class OSMOSDR_API device_t : public string_string_dict_t
  {
  public:
    /*!
     * Create a logical device from an args string.
     * \param args the arguments string
     */
    device_t(const std::string &args = "");

    /*!
     * Convert a logical device into a pretty print string.
     * \return a printable string representing the device
     */
    std::string to_pp_string(void) const;

    /*!
     * Convert the logical device into an args string.
     * The args string contains delimiter symbols.
     * \return a string with delimiter markup
     */
    std::string to_string(void) const;

    /*!
     * Lexically cast a parameter to the specified type,
     * or use the default value if the key is not found.
     * \param key the key as one of the parameters
     * \param def the value to use when key is not present
     * \return the casted value as type T or the default
     * \throw error when the parameter cannot be casted
     */
    template <typename T> T cast(const std::string &key, const T &def) const
    {
      if (!this->count(key)) return def;
      try { return boost::lexical_cast<T>((*this)[key]); }
      catch(const boost::bad_lexical_cast &) {
        throw std::runtime_error("cannot cast " + key + " = " + (*this)[key]);
      }
    }
  };

  //! A typedef for a vector of logical devices
  typedef std::vector<device_t> devices_t;

  /*!
   * The device interface represents the underyling hardware.
   * The api allows for discovery, configuration, and streaming.
   */
  class OSMOSDR_API device : boost::noncopyable
  {
  public:
    /*!
     * \brief Find logical radio devices attached to the host.
     *
     * The device hint should be used to narrow down the search
     * to particular transport types and/or transport arguments.
     *
     * \param hint a partially (or fully) filled in logical device
     * \return a vector of logical devices for all radios on the system
     */
    static devices_t find(const device_t &hint = osmosdr::device_t());
  };

} //namespace osmosdr

#endif /* INCLUDED_OSMOSDR_DEVICE_H */