Loading...
Searching...
No Matches
burst_tagger.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2010,2013 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_GR_BURST_TAGGER_H
#define INCLUDED_GR_BURST_TAGGER_H
#include <gnuradio/blocks/api.h>
#include <gnuradio/sync_block.h>
namespace gr {
namespace blocks {
/*!
* \brief Sets a burst on/off tag based on the value of the trigger input.
* \ingroup peak_detectors_blk
* \ingroup stream_tag_tools_blk
*
* \details
* This block takes two inputs, a signal stream on the input
* stream 0 and a trigger stream of shorts on input stream 1. If
* the trigger stream goes above 0, a tag with the key "burst"
* will be transmitted as a pmt::PMT_T. When the trigger signal
* falls below 0, the "burst" tag will be transmitted as
* pmt::PMT_F.
*
* The signal on stream 0 is retransmitted to output stream 0.
*/
class BLOCKS_API burst_tagger : virtual public sync_block
{
public:
// gr::blocks::burst_tagger::sptr
typedef std::shared_ptr<burst_tagger> sptr;
/*!
* Build a burst tagger gnuradio/blocks.
*
* \param itemsize itemsize of the signal stream on input 0.
*/
static sptr make(size_t itemsize);
/*!
* For the true burst tag, change the key name to \p key and a
* new value of \p value.
*/
virtual void set_true_tag(const std::string& key, bool value) = 0;
/*!
* For the false burst tag, change the key name to \p key and a
* new value of \p value.
*/
virtual void set_false_tag(const std::string& key, bool value) = 0;
};
} /* namespace blocks */
} /* namespace gr */
#endif /* INCLUDED_GR_BURST_TAGGER_H */
gr::blocks::burst_tagger
Sets a burst on/off tag based on the value of the trigger input.
Definition burst_tagger.h:36
gr::blocks::burst_tagger::make
static sptr make(size_t itemsize)
gr::blocks::burst_tagger::sptr
std::shared_ptr< burst_tagger > sptr
Definition burst_tagger.h:39
gr::blocks::burst_tagger::set_true_tag
virtual void set_true_tag(const std::string &key, bool value)=0
gr::blocks::burst_tagger::set_false_tag
virtual void set_false_tag(const std::string &key, bool value)=0
gr::sync_block
synchronous 1:1 input to output with history
Definition sync_block.h:26
api.h
BLOCKS_API
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:18
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h