diff options
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/message_strobe.h')
-rw-r--r-- | gr-blocks/include/gnuradio/blocks/message_strobe.h | 82 |
1 files changed, 41 insertions, 41 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/message_strobe.h b/gr-blocks/include/gnuradio/blocks/message_strobe.h index 553a1c0f9e..2a2fbdae5b 100644 --- a/gr-blocks/include/gnuradio/blocks/message_strobe.h +++ b/gr-blocks/include/gnuradio/blocks/message_strobe.h @@ -27,56 +27,56 @@ #include <gnuradio/block.h> namespace gr { - namespace blocks { +namespace blocks { + +/*! + * \brief Send message at defined interval + * \ingroup message_tools_blk + * + * \details + * Takes a PMT message and sends it out every \p period_ms + * milliseconds. Useful for testing/debugging the message system. + */ +class BLOCKS_API message_strobe : virtual public block +{ +public: + // gr::blocks::message_strobe::sptr + typedef boost::shared_ptr<message_strobe> sptr; /*! - * \brief Send message at defined interval - * \ingroup message_tools_blk + * Make a message stobe block to send message \p msg every \p + * period_ms milliseconds. * - * \details - * Takes a PMT message and sends it out every \p period_ms - * milliseconds. Useful for testing/debugging the message system. + * \param msg The message to send as a PMT. + * \param period_ms the time period in milliseconds in which to + * send \p msg. */ - class BLOCKS_API message_strobe : virtual public block - { - public: - // gr::blocks::message_strobe::sptr - typedef boost::shared_ptr<message_strobe> sptr; + static sptr make(pmt::pmt_t msg, long period_ms); - /*! - * Make a message stobe block to send message \p msg every \p - * period_ms milliseconds. - * - * \param msg The message to send as a PMT. - * \param period_ms the time period in milliseconds in which to - * send \p msg. - */ - static sptr make(pmt::pmt_t msg, long period_ms); - - /*! - * Reset the message being sent. - * \param msg The message to send as a PMT. - */ - virtual void set_msg(pmt::pmt_t msg) = 0; + /*! + * Reset the message being sent. + * \param msg The message to send as a PMT. + */ + virtual void set_msg(pmt::pmt_t msg) = 0; - /*! - * Get the value of the message being sent. - */ - virtual pmt::pmt_t msg() const = 0; + /*! + * Get the value of the message being sent. + */ + virtual pmt::pmt_t msg() const = 0; - /*! - * Reset the sending interval. - * \param period_ms the time period in milliseconds. - */ - virtual void set_period(long period_ms) = 0; + /*! + * Reset the sending interval. + * \param period_ms the time period in milliseconds. + */ + virtual void set_period(long period_ms) = 0; - /*! - * Get the time interval of the strobe. - */ - virtual long period() const = 0; - }; + /*! + * Get the time interval of the strobe. + */ + virtual long period() const = 0; +}; - } /* namespace blocks */ +} /* namespace blocks */ } /* namespace gr */ #endif /* INCLUDED_GR_MESSAGE_STROBE_H */ |