GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
message_strobe.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2012-2013 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23#ifndef INCLUDED_GR_MESSAGE_STROBE_H
24#define INCLUDED_GR_MESSAGE_STROBE_H
25
26#include <gnuradio/block.h>
27#include <gnuradio/blocks/api.h>
28
29namespace gr {
30namespace blocks {
31
32/*!
33 * \brief Send message at defined interval
34 * \ingroup message_tools_blk
35 *
36 * \details
37 * Takes a PMT message and sends it out every \p period_ms
38 * milliseconds. Useful for testing/debugging the message system.
39 */
40class BLOCKS_API message_strobe : virtual public block
41{
42public:
43 // gr::blocks::message_strobe::sptr
44 typedef boost::shared_ptr<message_strobe> sptr;
45
46 /*!
47 * Make a message stobe block to send message \p msg every \p
48 * period_ms milliseconds.
49 *
50 * \param msg The message to send as a PMT.
51 * \param period_ms the time period in milliseconds in which to
52 * send \p msg.
53 */
54 static sptr make(pmt::pmt_t msg, float period_ms);
55
56 /*!
57 * Reset the message being sent.
58 * \param msg The message to send as a PMT.
59 */
60 virtual void set_msg(pmt::pmt_t msg) = 0;
61
62 /*!
63 * Get the value of the message being sent.
64 */
65 virtual pmt::pmt_t msg() const = 0;
66
67 /*!
68 * Reset the sending interval.
69 * \param period_ms the time period in milliseconds.
70 */
71 virtual void set_period(float period_ms) = 0;
72
73 /*!
74 * Get the time interval of the strobe.
75 */
76 virtual float period() const = 0;
77};
78
79} /* namespace blocks */
80} /* namespace gr */
81
82#endif /* INCLUDED_GR_MESSAGE_STROBE_H */
The abstract base class for all 'terminal' processing blocks.
Definition: block.h:66
Send message at defined interval.
Definition: message_strobe.h:41
virtual pmt::pmt_t msg() const =0
static sptr make(pmt::pmt_t msg, float period_ms)
virtual void set_period(float period_ms)=0
boost::shared_ptr< message_strobe > sptr
Definition: message_strobe.h:44
virtual float period() const =0
virtual void set_msg(pmt::pmt_t msg)=0
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
static purpose_t msg
Definition: source_logger.h:39
Include this header to use the message passing features.
Definition: basic_block.h:45
boost::intrusive_ptr< pmt_base > pmt_t
typedef for shared pointer (transparent reference counting). See http://www.boost....
Definition: pmt.h:56