Loading...
Searching...
No Matches
top_block.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2007-2009,2013 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_GR_TOP_BLOCK_H
#define INCLUDED_GR_TOP_BLOCK_H
#include <gnuradio/api.h>
#include <gnuradio/hier_block2.h>
namespace gr {
class top_block_impl;
GR_RUNTIME_API top_block_sptr make_top_block(const std::string& name,
bool catch_exceptions = true);
/*!
*\brief Top-level hierarchical block representing a flowgraph
* \ingroup container_blk
*/
class GR_RUNTIME_API top_block : public hier_block2
{
private:
template <typename T, typename... Args>
friend std::shared_ptr<T> gnuradio::make_block_sptr(Args&&... args);
std::unique_ptr<top_block_impl> d_impl;
protected:
top_block(const std::string& name, bool catch_exceptions = true);
public:
~top_block() override;
/*!
* \brief The simple interface to running a flowgraph.
*
* Calls start() then wait(). Used to run a flowgraph that will
* stop on its own, or when another thread will call stop().
*
* \param max_noutput_items the maximum number of output items
* allowed for any block in the flowgraph. This passes through to
* the start function; see that function for more details.
*/
void run(int max_noutput_items = 100000000);
/*!
* Start the contained flowgraph. Creates one or more threads to
* execute the flow graph. Returns to the caller once the threads
* are created. Calling start() on a top_block that is already
* started IS an error.
*
* \param max_noutput_items the maximum number of output items
* allowed for any block in the flowgraph; the noutput_items can
* always be less than this, but this will cap it as a
* maximum. Use this to adjust the maximum latency a flowgraph can
* exhibit.
*/
void start(int max_noutput_items = 100000000);
/*!
* Stop the running flowgraph. Notifies each thread created by the
* scheduler to shutdown, then returns to caller. Calling stop()
* on a top_block that is already stopped IS NOT an error.
*/
void stop();
/*!
* Wait for a flowgraph to complete. Flowgraphs complete when
* either (1) all blocks indicate that they are done (typically
* only when using blocks.file_source, or blocks.head, or (2)
* after stop() has been called to request shutdown. Calling wait
* on a top_block that is not running IS NOT an error (wait
* returns w/o blocking).
*/
void wait();
/*!
* Lock a flowgraph in preparation for reconfiguration. When an
* equal number of calls to lock() and unlock() have occurred, the
* flowgraph will be reconfigured.
*
* N.B. lock() and unlock() may not be called from a flowgraph
* thread (E.g., block::work method) or deadlock will occur
* when reconfiguration happens.
*/
void lock() override;
/*!
* Unlock a flowgraph in preparation for reconfiguration. When an
* equal number of calls to lock() and unlock() have occurred, the
* flowgraph will be reconfigured.
*
* N.B. lock() and unlock() may not be called from a flowgraph thread
* (E.g., block::work method) or deadlock will occur when
* reconfiguration happens.
*/
void unlock() override;
/*!
* Returns a string that lists the edge connections in the
* flattened flowgraph.
*/
std::string edge_list();
/*!
* Returns a string that lists the msg edge connections in the
* flattened flowgraph.
*/
std::string msg_edge_list();
/*!
* Displays flattened flowgraph edges and block connectivity
*/
void dump();
//! Get the number of max noutput_items in the flowgraph
int max_noutput_items();
//! Set the maximum number of noutput_items in the flowgraph
void set_max_noutput_items(int nmax);
top_block_sptr to_top_block(); // Needed for Python type coercion
void setup_rpc() override;
};
inline top_block_sptr cast_to_top_block_sptr(basic_block_sptr block)
{
return std::dynamic_pointer_cast<top_block, basic_block>(block);
}
} // namespace gr
#endif /* INCLUDED_GR_TOP_BLOCK_H */
gr::basic_block::name
std::string name() const
Definition basic_block.h:168
gr::block
The abstract base class for all 'terminal' processing blocks.
Definition gnuradio-runtime/include/gnuradio/block.h:63
gr::hier_block2::hier_block2
hier_block2()
gr::top_block::set_max_noutput_items
void set_max_noutput_items(int nmax)
Set the maximum number of noutput_items in the flowgraph.
gr::top_block::start
void start(int max_noutput_items=100000000)
gr::top_block::msg_edge_list
std::string msg_edge_list()
gr::top_block::wait
void wait()
gr::top_block::dump
void dump()
gr::top_block::top_block
top_block(const std::string &name, bool catch_exceptions=true)
gr::top_block::~top_block
~top_block() override
gr::top_block::lock
void lock() override
gr::top_block::setup_rpc
void setup_rpc() override
Set up the RPC registered variables.
gr::top_block::to_top_block
top_block_sptr to_top_block()
gr::top_block::edge_list
std::string edge_list()
gr::top_block::stop
void stop()
gr::top_block::max_noutput_items
int max_noutput_items()
Get the number of max noutput_items in the flowgraph.
gr::top_block::run
void run(int max_noutput_items=100000000)
The simple interface to running a flowgraph.
gr::top_block::unlock
void unlock() override
api.h
GR_RUNTIME_API
#define GR_RUNTIME_API
Definition gnuradio-runtime/include/gnuradio/api.h:18
hier_block2.h
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
gr::make_top_block
GR_RUNTIME_API top_block_sptr make_top_block(const std::string &name, bool catch_exceptions=true)