23#ifndef INCLUDED_GR_BASIC_BLOCK_H
24#define INCLUDED_GR_BASIC_BLOCK_H
32#include <boost/enable_shared_from_this.hpp>
33#include <boost/foreach.hpp>
34#include <boost/function.hpp>
35#include <boost/thread/condition_variable.hpp>
59 public boost::enable_shared_from_this<basic_block>
61 typedef boost::function<void(
pmt::pmt_t)> msg_handler_t;
64 typedef std::map<pmt::pmt_t, msg_handler_t, pmt::comparator> d_msg_handlers_t;
65 d_msg_handlers_t d_msg_handlers;
67 typedef std::deque<pmt::pmt_t> msg_queue_t;
68 typedef std::map<pmt::pmt_t, msg_queue_t, pmt::comparator> msg_queue_map_t;
69 typedef std::map<pmt::pmt_t, msg_queue_t, pmt::comparator>::iterator
71 std::map<pmt::pmt_t, boost::shared_ptr<boost::condition_variable>,
pmt::comparator>
78 friend class flat_flowgraph;
79 friend class tpb_thread_body;
109 d_output_signature = iosig;
123 return (d_msg_handlers.find(which_port) != d_msg_handlers.end());
135 if (has_msg_handler(which_port)) {
136 d_msg_handlers[which_port](
msg);
150 std::string
name()
const {
return d_name; }
171 std::string
alias() {
return alias_set() ? d_symbol_alias : symbol_name(); }
233 throw std::runtime_error(
"port does not exist!");
239 BOOST_FOREACH (msg_queue_map_t::value_type& i,
msg_queue) {
248 return (empty_p(which_port) || !has_msg_handler(which_port));
253 BOOST_FOREACH (msg_queue_map_t::value_type& i,
msg_queue) {
254 rv &= empty_handled_p(i.first);
263 throw std::runtime_error(
"port does not exist!");
317 void add_rpc_variable(rpcbasic_sptr s) { d_rpc_vars.push_back(s); }
390 template <
typename T>
394 throw std::runtime_error(
395 "attempt to set_msg_handler() on bad input message port!");
397 d_msg_handlers[which_port] = msg_handler_t(
msg_handler);
402 throw std::runtime_error(
"set_processor_affinity not overloaded in child class.");
407 throw std::runtime_error(
408 "unset_processor_affinity not overloaded in child class.");
413 throw std::runtime_error(
"processor_affinity not overloaded in child class.");
417inline bool operator<(basic_block_sptr lhs, basic_block_sptr rhs)
419 return lhs->unique_id() < rhs->unique_id();
The abstract base class for all signal processing blocks.
Definition: basic_block.h:60
gr::io_signature::sptr input_signature() const
Definition: basic_block.h:159
virtual std::vector< int > processor_affinity()
Definition: basic_block.h:411
bool empty_handled_p(pmt::pmt_t which_port)
are all msg ports with handlers empty?
Definition: basic_block.h:246
bool is_rpc_set()
Ask if this block has been registered to the RPC.
Definition: basic_block.h:336
pmt::pmt_t message_subscribers(pmt::pmt_t port)
virtual bool message_port_is_hier_out(pmt::pmt_t port_id)
Definition: basic_block.h:202
void set_color(vcolor color)
Allow the flowgraph to set for sorting and partitioning.
Definition: basic_block.h:115
std::string d_symbol_alias
Definition: basic_block.h:89
long unique_id() const
Definition: basic_block.h:146
const msg_queue_map_t & get_msg_map(void) const
Definition: basic_block.h:302
msg_queue_t::iterator get_iterator(pmt::pmt_t which_port)
Definition: basic_block.h:281
void message_port_register_in(pmt::pmt_t port_id)
void set_input_signature(gr::io_signature::sptr iosig)
may only be called during constructor
Definition: basic_block.h:104
std::string alias()
Definition: basic_block.h:171
basic_block(const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
Protected constructor prevents instantiation by non-derived classes.
void message_port_pub(pmt::pmt_t port_id, pmt::pmt_t msg)
std::vector< boost::any > d_rpc_vars
Definition: basic_block.h:94
size_t nmsgs(pmt::pmt_t which_port)
How many messages in the queue?
Definition: basic_block.h:260
virtual bool message_port_is_hier_in(pmt::pmt_t port_id)
Definition: basic_block.h:197
virtual void set_processor_affinity(const std::vector< int > &mask)
Definition: basic_block.h:400
msg_queue_map_t msg_queue
Definition: basic_block.h:93
basic_block(void)
Definition: basic_block.h:96
long d_symbolic_id
Definition: basic_block.h:87
bool empty_handled_p()
Definition: basic_block.h:250
void set_output_signature(gr::io_signature::sptr iosig)
may only be called during constructor
Definition: basic_block.h:107
long symbolic_id() const
Definition: basic_block.h:147
virtual void setup_rpc()
Set up the RPC registered variables.
Definition: basic_block.h:328
void set_msg_handler(pmt::pmt_t which_port, T msg_handler)
Set the callback that is fired when messages are available.
Definition: basic_block.h:391
pmt::pmt_t alias_pmt()
Definition: basic_block.h:176
basic_block_sptr to_basic_block()
gr::io_signature::sptr d_output_signature
Definition: basic_block.h:85
gr::io_signature::sptr d_input_signature
Definition: basic_block.h:84
virtual bool message_port_is_hier(pmt::pmt_t port_id)
Definition: basic_block.h:192
long d_unique_id
Definition: basic_block.h:86
virtual bool has_msg_port(pmt::pmt_t which_port)
Definition: basic_block.h:291
bool d_rpc_set
Definition: basic_block.h:91
virtual void dispatch_msg(pmt::pmt_t which_port, pmt::pmt_t msg)
Definition: basic_block.h:132
bool alias_set()
Definition: basic_block.h:166
std::string symbol_name() const
Definition: basic_block.h:157
void _post(pmt::pmt_t which_port, pmt::pmt_t msg)
void message_port_register_out(pmt::pmt_t port_id)
void rpc_set()
When the block is registered with the RPC, set this.
Definition: basic_block.h:341
vcolor
Definition: basic_block.h:81
virtual bool has_msg_handler(pmt::pmt_t which_port)
Tests if there is a handler attached to port which_port.
Definition: basic_block.h:121
virtual bool check_topology(int ninputs, int noutputs)
Confirm that ninputs and noutputs is an acceptable combination.
Definition: basic_block.h:356
void insert_tail(pmt::pmt_t which_port, pmt::pmt_t msg)
pmt::pmt_t delete_head_blocking(pmt::pmt_t which_port, unsigned int millisec=0)
virtual void unset_processor_affinity()
Definition: basic_block.h:405
void erase_msg(pmt::pmt_t which_port, msg_queue_t::iterator it)
Definition: basic_block.h:286
void set_block_alias(std::string name)
void message_port_unsub(pmt::pmt_t port_id, pmt::pmt_t target)
pmt::pmt_t message_ports_out()
Get output message port names.
std::string d_name
Definition: basic_block.h:83
void message_port_sub(pmt::pmt_t port_id, pmt::pmt_t target)
gr::io_signature::sptr output_signature() const
Definition: basic_block.h:160
vcolor color() const
Definition: basic_block.h:116
pmt::pmt_t message_ports_in()
Get input message port names.
bool empty_p(pmt::pmt_t which_port)
is the queue empty?
Definition: basic_block.h:230
bool empty_p()
Definition: basic_block.h:236
pmt::pmt_t d_message_subscribers
Definition: basic_block.h:141
std::string name() const
Definition: basic_block.h:150
std::string d_symbol_name
Definition: basic_block.h:88
pmt::pmt_t delete_head_nowait(pmt::pmt_t which_port)
vcolor d_color
Definition: basic_block.h:90
Class representing a directed, acyclic graph of basic blocks.
Definition: flowgraph.h:147
boost::shared_ptr< io_signature > sptr
Definition: io_signature.h:46
Accepts messages and inserts them into a message queue, then notifies subclass gr::basic_block there ...
Definition: msg_accepter.h:36
abstract class of message handlers
Definition: msg_handler.h:39
thread-safe message queue
Definition: msg_queue.h:37
Provide a comparator function object to allow pmt use in stl types.
Definition: pmt.h:956
#define GR_RUNTIME_API
Definition: gnuradio-runtime/include/gnuradio/api.h:30
static purpose_t msg
Definition: source_logger.h:39
boost::mutex mutex
Definition: thread.h:48
Include this header to use the message passing features.
Definition: basic_block.h:45
std::vector< basic_block_sptr > basic_block_vector_t
Definition: basic_block.h:422
std::ostream & operator<<(std::ostream &os, basic_block_sptr basic_block)
Definition: basic_block.h:427
bool operator<(basic_block_sptr lhs, basic_block_sptr rhs)
Definition: basic_block.h:417
std::vector< basic_block_sptr >::iterator basic_block_viter_t
Definition: basic_block.h:423
GR_RUNTIME_API long basic_block_ncurrently_allocated()
PMT_API bool dict_has_key(const pmt_t &dict, const pmt_t &key)
Return true if key exists in dict.
PMT_API pmt_t intern(const std::string &s)
Alias for pmt_string_to_symbol.
boost::intrusive_ptr< pmt_base > pmt_t
typedef for shared pointer (transparent reference counting). See http://www.boost....
Definition: pmt.h:56