device_source.h

Go to the documentation of this file.

/* -*- c++ -*- */
/* 
 * Copyright 2014 Analog Devices Inc.
 * Author: Paul Cercueil <paul.cercueil@analog.com>
 * 
 * This 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.
 * 
 * This software 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 this software; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */


#ifndef INCLUDED_IIO_DEVICE_SOURCE_H
#define INCLUDED_IIO_DEVICE_SOURCE_H

#include <iio/api.h>
#include <gnuradio/sync_block.h>

#define DEFAULT_BUFFER_SIZE 0x8000

extern "C" {
        struct iio_context;
};

namespace gr {
  namespace iio {

    /*!
     * \brief <+description of block+>
     * \ingroup iio
     *
     */
    class IIO_API device_source : virtual public gr::sync_block
    {
     public:
      typedef std::shared_ptr<device_source> sptr;

      /*!
       * \brief Return a shared_ptr to a new instance of iio::device.
       *
       * To avoid accidental use of raw pointers, iio::device's
       * constructor is in a private implementation
       * class. iio::device::make is the public interface for
       * creating new instances.
       */
      static sptr make(const std::string &uri, const std::string &device,
                      const std::vector<std::string> &channels,
                      const std::string &device_phy,
                      const std::vector<std::string> &params,
                      unsigned int buffer_size = DEFAULT_BUFFER_SIZE,
                      unsigned int decimation = 0);

      static sptr make_from(struct iio_context *ctx, const std::string &device,
                      const std::vector<std::string> &channels,
                      const std::string &device_phy,
                      const std::vector<std::string> &params,
                      unsigned int buffer_size = DEFAULT_BUFFER_SIZE,
                      unsigned int decimation = 0);

      virtual void set_buffer_size(unsigned int buffer_size) = 0;
      virtual void set_timeout_ms(unsigned long timeout) = 0;
    };

  } // namespace iio
} // namespace gr

#endif /* INCLUDED_IIO_DEVICE_SOURCE_H */