Loading...
Searching...
No Matches
regenerate_bb.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2007,2013 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_GR_REGENERATE_BB_H
#define INCLUDED_GR_REGENERATE_BB_H
#include <gnuradio/blocks/api.h>
#include <gnuradio/sync_block.h>
namespace gr {
namespace blocks {
/*!
* \brief Detect the peak of a signal and repeat every period samples
* \ingroup stream_operators_blk
*
* \details
* If a peak is detected, this block outputs a 1 repeated every
* period samples until reset by detection of another 1 on the
* input or stopped after max_regen regenerations have occurred.
*
* Note that if max_regen=(-1)/ULONG_MAX then the regeneration
* will run forever.
*/
class BLOCKS_API regenerate_bb : virtual public sync_block
{
public:
// gr::blocks::regenerate_bb::sptr
typedef std::shared_ptr<regenerate_bb> sptr;
/*!
* \brief Make a regenerate block
* \param period The number of samples between regenerations
* \param max_regen The maximum number of regenerations to
* perform; if set to ULONG_MAX, it will regenerate
* continuously.
*/
static sptr make(int period, unsigned int max_regen = 500);
/*! \brief Reset the maximum regeneration count; this will reset
the current regen.
*/
virtual void set_max_regen(unsigned int regen) = 0;
/*! \brief Reset the period of regenerations; this will reset
the current regen.
*/
virtual void set_period(int period) = 0;
/*! \brief return the maximum regeneration count.
*/
virtual unsigned int max_regen() const = 0;
/*! \brief return the regeneration period.
*/
virtual int period() const = 0;
};
} /* namespace blocks */
} /* namespace gr */
#endif /* INCLUDED_GR_REGENERATE_BB_H */
gr::blocks::regenerate_bb
Detect the peak of a signal and repeat every period samples.
Definition regenerate_bb.h:33
gr::blocks::regenerate_bb::make
static sptr make(int period, unsigned int max_regen=500)
Make a regenerate block.
gr::blocks::regenerate_bb::max_regen
virtual unsigned int max_regen() const =0
return the maximum regeneration count.
gr::blocks::regenerate_bb::period
virtual int period() const =0
return the regeneration period.
gr::blocks::regenerate_bb::set_period
virtual void set_period(int period)=0
Reset the period of regenerations; this will reset the current regen.
gr::blocks::regenerate_bb::sptr
std::shared_ptr< regenerate_bb > sptr
Definition regenerate_bb.h:36
gr::blocks::regenerate_bb::set_max_regen
virtual void set_max_regen(unsigned int regen)=0
Reset the maximum regeneration count; this will reset the current regen.
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
BLOCKS_API
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:18
gr::blocks
Definition abs_blk.h:20
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h