GNU Radio 3.6.5 C++ API

message_strobe.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_GR_MESSAGE_STROBE_H
00024 #define INCLUDED_GR_MESSAGE_STROBE_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief Send message at defined interval
00034      * \ingroup message_tools_blk
00035      *
00036      * \details
00037      * Takes a PMT message and sends it out every \p period_ms
00038      * milliseconds. Useful for testing/debugging the message system.
00039      */
00040     class BLOCKS_API message_strobe : virtual public gr_block
00041     {
00042     public:
00043       // gr::blocks::message_strobe::sptr
00044       typedef boost::shared_ptr<message_strobe> sptr;
00045 
00046       /*!
00047        * Make a message stobe block to send message \p msg every \p
00048        * period_ms milliseconds.
00049        *
00050        * \param msg The message to send as a PMT.
00051        * \param period_ms the time period in milliseconds in which to
00052        *                  send \p msg.
00053        */
00054       static sptr make(pmt::pmt_t msg, float period_ms);
00055 
00056       /*!
00057        * Reset the message being sent.
00058        * \param msg The message to send as a PMT.
00059        */
00060       virtual void set_msg(pmt::pmt_t msg) = 0;
00061 
00062       /*!
00063        * Get the value of the message being sent.
00064        */
00065       virtual pmt::pmt_t msg() const = 0;
00066 
00067       /*!
00068        * Reset the sending interval.
00069        * \param period_ms the time period in milliseconds.
00070        */
00071       virtual void set_period(float period_ms) = 0;
00072 
00073       /*!
00074        * Get the time interval of the strobe.
00075        */
00076       virtual float period() const = 0;
00077     };
00078 
00079   } /* namespace blocks */
00080 } /* namespace gr */
00081 
00082 #endif /* INCLUDED_GR_MESSAGE_STROBE_H */