GNU Radio 3.7.1 C++ API
ctrlport_probe2_c.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2012-2013 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_CTRLPORT_PROBE2_C_H
00024 #define INCLUDED_CTRLPORT_PROBE2_C_H
00025 
00026 #include <gnuradio/blocks/api.h>
00027 #include <gnuradio/sync_block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief A ControlPort probe to export vectors of signals.
00034      * \ingroup measurement_tools_blk
00035      * \ingroup controlport_blk
00036      *
00037      * \details
00038      * This block acts as a sink in the flowgraph but also exports
00039      * vectors of complex samples over ControlPort. This block holds
00040      * the latest \p len number of complex samples so that every query
00041      * by a ControlPort client will get the same length vector.
00042      */
00043     class BLOCKS_API ctrlport_probe2_c : virtual public sync_block
00044     {
00045     public:
00046       // gr::blocks::ctrlport_probe2_c::sptr
00047       typedef boost::shared_ptr<ctrlport_probe2_c> sptr;
00048 
00049       /*!
00050        * \brief Make a ControlPort probe block.
00051        * \param id A string ID to name the probe over ControlPort.
00052        * \param desc A string describing the probe.
00053        * \param len Number of samples to transmit.
00054        * \param disp_mask Mask to set default display params.
00055        */
00056       static sptr make(const std::string &id, const std::string &desc,
00057                        int len, unsigned int disp_mask);
00058 
00059       virtual std::vector<gr_complex> get() = 0;
00060 
00061       virtual void set_length(int len) = 0;
00062       virtual int length() const = 0;
00063     };
00064 
00065   } /* namespace blocks */
00066 } /* namespace gr */
00067 
00068 #endif /* INCLUDED_CTRLPORT_PROBE2_C_H */
00069