GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
block_gateway.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2011-2013,2017 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23#ifndef INCLUDED_RUNTIME_BLOCK_GATEWAY_H
24#define INCLUDED_RUNTIME_BLOCK_GATEWAY_H
25
26#include <gnuradio/api.h>
27#include <gnuradio/block.h>
28#include <gnuradio/feval.h>
29
30namespace gr {
31
32/*!
33 * The work type enum tells the gateway what kind of block to
34 * implement. The choices are familiar gnuradio block overloads
35 * (sync, decim, interp).
36 */
42};
43
44//! Magic return values from general_work, \ref gr::block::WORK_CALLED_PRODUCE
50 TPP_CUSTOM = 3
51};
52
53/*!
54 * Shared message structure between python and gateway.
55 * Each action type represents a scheduler-called function.
56 */
59 ACTION_GENERAL_WORK, // dispatch work
60 ACTION_WORK, // dispatch work
61 ACTION_FORECAST, // dispatch forecast
62 ACTION_START, // dispatch start
63 ACTION_STOP, // dispatch stop
64 };
65
67
70 std::vector<void*> general_work_args_input_items; // TODO this should be const void*,
71 // but swig can't int cast it right
74
77 std::vector<void*> work_args_input_items; // TODO this should be const void*, but swig
78 // can't int cast it right
79 std::vector<void*> work_args_output_items;
81
84
86
88};
89
90/*!
91 * The gateway block which performs all the magic.
92 *
93 * The gateway provides access to all the gr::block routines.
94 * The methods prefixed with gr::block__ are renamed
95 * to class methods without the prefix in python.
96 */
98{
99public:
100 // gr::block_gateway::sptr
101 typedef boost::shared_ptr<block_gateway> sptr;
102
103 /*!
104 * Make a new gateway block.
105 * \param handler the swig director object with callback
106 * \param name the name of the block (Ex: "Shirley")
107 * \param in_sig the input signature for this block
108 * \param out_sig the output signature for this block
109 * \param work_type the type of block overload to implement
110 * \param factor the decimation or interpolation factor
111 * \return a new gateway block
112 */
113 static sptr make(gr::feval_ll* handler,
114 const std::string& name,
117 const block_gw_work_type work_type,
118 const unsigned factor);
119
120 //! Provide access to the shared message object
122
123 long block__unique_id(void) const { return gr::block::unique_id(); }
124
125 std::string block__name(void) const { return gr::block::name(); }
126
127 unsigned block__history(void) const { return gr::block::history(); }
128
129 void block__set_history(unsigned history) { return gr::block::set_history(history); }
130
131 void block__set_fixed_rate(bool fixed_rate)
132 {
133 return gr::block::set_fixed_rate(fixed_rate);
134 }
135
136 bool block__fixed_rate(void) const { return gr::block::fixed_rate(); }
137
138 void block__set_output_multiple(int multiple)
139 {
140 return gr::block::set_output_multiple(multiple);
141 }
142
143 void block__set_min_output_buffer(int port, long size)
144 {
145 return gr::block::set_min_output_buffer(port, size);
146 }
147
149 {
151 }
152
154
155 void block__consume(int which_input, int how_many_items)
156 {
157 return gr::block::consume(which_input, how_many_items);
158 }
159
160 void block__consume_each(int how_many_items)
161 {
162 return gr::block::consume_each(how_many_items);
163 }
164
165 void block__produce(int which_output, int how_many_items)
166 {
167 return gr::block::produce(which_output, how_many_items);
168 }
169
170 void block__set_relative_rate(double relative_rate)
171 {
172 return gr::block::set_relative_rate(relative_rate);
173 }
174
175 double block__relative_rate(void) const { return gr::block::relative_rate(); }
176
177 uint64_t block__nitems_read(unsigned int which_input)
178 {
179 return gr::block::nitems_read(which_input);
180 }
181
182 uint64_t block__nitems_written(unsigned int which_output)
183 {
184 return gr::block::nitems_written(which_output);
185 }
186
188 {
190 }
191
193 {
195 }
196
197 void block__add_item_tag(unsigned int which_output, const tag_t& tag)
198 {
199 return gr::block::add_item_tag(which_output, tag);
200 }
201
202 void block__add_item_tag(unsigned int which_output,
203 uint64_t abs_offset,
204 const pmt::pmt_t& key,
205 const pmt::pmt_t& value,
206 const pmt::pmt_t& srcid = pmt::PMT_F)
207 {
208 return gr::block::add_item_tag(which_output, abs_offset, key, value, srcid);
209 }
210
211 std::vector<tag_t> block__get_tags_in_range(unsigned int which_input,
212 uint64_t abs_start,
213 uint64_t abs_end)
214 {
215 std::vector<gr::tag_t> tags;
216 gr::block::get_tags_in_range(tags, which_input, abs_start, abs_end);
217 return tags;
218 }
219
220 std::vector<tag_t> block__get_tags_in_range(unsigned int which_input,
221 uint64_t abs_start,
222 uint64_t abs_end,
223 const pmt::pmt_t& key)
224 {
225 std::vector<gr::tag_t> tags;
226 gr::block::get_tags_in_range(tags, which_input, abs_start, abs_end, key);
227 return tags;
228 }
229
230 std::vector<tag_t> block__get_tags_in_window(unsigned int which_input,
231 uint64_t rel_start,
232 uint64_t rel_end)
233 {
234 std::vector<gr::tag_t> tags;
235 gr::block::get_tags_in_window(tags, which_input, rel_start, rel_end);
236 return tags;
237 }
238
239 std::vector<tag_t> block__get_tags_in_window(unsigned int which_input,
240 uint64_t rel_start,
241 uint64_t rel_end,
242 const pmt::pmt_t& key)
243 {
244 std::vector<gr::tag_t> tags;
245 gr::block::get_tags_in_window(tags, which_input, rel_start, rel_end, key);
246 return tags;
247 }
248
249 /* Message passing interface */
251 {
253 }
254
256 {
258 }
259
261 {
263 }
264
266 {
267 gr::basic_block::message_port_sub(port_id, target);
268 }
269
271 {
273 }
274
276 {
277 return gr::basic_block::message_subscribers(which_port);
278 }
279
281
283
285 {
286 if (msg_queue.find(which_port) == msg_queue.end()) {
287 throw std::runtime_error(
288 "attempt to set_msg_handler_feval() on bad input message port!");
289 }
290 d_msg_handlers_feval[which_port] = msg_handler;
291 }
292
293protected:
294 typedef std::map<pmt::pmt_t, feval_p*, pmt::comparator> msg_handlers_feval_t;
296
298 {
299 return (d_msg_handlers_feval.find(which_port) != d_msg_handlers_feval.end());
300 }
301
303 {
304 // Is there a handler?
305 if (d_msg_handlers_feval.find(which_port) != d_msg_handlers_feval.end()) {
306 d_msg_handlers_feval[which_port]->calleval(msg); // Yes, invoke it.
307 } else {
308 // Pass to generic dispatcher if not found
310 }
311 }
312};
313
314} /* namespace gr */
315
316#endif /* INCLUDED_RUNTIME_BLOCK_GATEWAY_H */
pmt::pmt_t message_subscribers(pmt::pmt_t port)
long unique_id() const
Definition: basic_block.h:146
void message_port_register_in(pmt::pmt_t port_id)
void message_port_pub(pmt::pmt_t port_id, pmt::pmt_t msg)
virtual void dispatch_msg(pmt::pmt_t which_port, pmt::pmt_t msg)
Definition: basic_block.h:132
void message_port_register_out(pmt::pmt_t port_id)
void message_port_unsub(pmt::pmt_t port_id, pmt::pmt_t target)
pmt::pmt_t message_ports_out()
Get output message port names.
void message_port_sub(pmt::pmt_t port_id, pmt::pmt_t target)
pmt::pmt_t message_ports_in()
Get input message port names.
std::string name() const
Definition: basic_block.h:150
Definition: block_gateway.h:98
virtual block_gw_message_type & block_message(void)=0
Provide access to the shared message object.
void block__set_min_output_buffer(long size)
Definition: block_gateway.h:148
std::vector< tag_t > block__get_tags_in_range(unsigned int which_input, uint64_t abs_start, uint64_t abs_end)
Definition: block_gateway.h:211
double block__relative_rate(void) const
Definition: block_gateway.h:175
int block__output_multiple(void) const
Definition: block_gateway.h:153
void block__message_port_unsub(pmt::pmt_t port_id, pmt::pmt_t target)
Definition: block_gateway.h:270
std::string block__name(void) const
Definition: block_gateway.h:125
bool block__fixed_rate(void) const
Definition: block_gateway.h:136
void block__message_port_register_out(pmt::pmt_t port_id)
Definition: block_gateway.h:255
pmt::pmt_t block__message_ports_out()
Definition: block_gateway.h:282
std::vector< tag_t > block__get_tags_in_window(unsigned int which_input, uint64_t rel_start, uint64_t rel_end, const pmt::pmt_t &key)
Definition: block_gateway.h:239
void block__add_item_tag(unsigned int which_output, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
Definition: block_gateway.h:202
std::map< pmt::pmt_t, feval_p *, pmt::comparator > msg_handlers_feval_t
Definition: block_gateway.h:294
long block__unique_id(void) const
Definition: block_gateway.h:123
static sptr make(gr::feval_ll *handler, const std::string &name, gr::io_signature::sptr in_sig, gr::io_signature::sptr out_sig, const block_gw_work_type work_type, const unsigned factor)
void block__message_port_register_in(pmt::pmt_t port_id)
Definition: block_gateway.h:250
block::tag_propagation_policy_t block__tag_propagation_policy(void)
Definition: block_gateway.h:187
msg_handlers_feval_t d_msg_handlers_feval
Definition: block_gateway.h:295
void block__add_item_tag(unsigned int which_output, const tag_t &tag)
Definition: block_gateway.h:197
uint64_t block__nitems_read(unsigned int which_input)
Definition: block_gateway.h:177
std::vector< tag_t > block__get_tags_in_range(unsigned int which_input, uint64_t abs_start, uint64_t abs_end, const pmt::pmt_t &key)
Definition: block_gateway.h:220
std::vector< tag_t > block__get_tags_in_window(unsigned int which_input, uint64_t rel_start, uint64_t rel_end)
Definition: block_gateway.h:230
unsigned block__history(void) const
Definition: block_gateway.h:127
pmt::pmt_t block__message_subscribers(pmt::pmt_t which_port)
Definition: block_gateway.h:275
void dispatch_msg(pmt::pmt_t which_port, pmt::pmt_t msg)
Definition: block_gateway.h:302
void block__message_port_pub(pmt::pmt_t port_id, pmt::pmt_t msg)
Definition: block_gateway.h:260
void block__set_history(unsigned history)
Definition: block_gateway.h:129
void block__message_port_sub(pmt::pmt_t port_id, pmt::pmt_t target)
Definition: block_gateway.h:265
void block__set_relative_rate(double relative_rate)
Definition: block_gateway.h:170
void set_msg_handler_feval(pmt::pmt_t which_port, gr::feval_p *msg_handler)
Definition: block_gateway.h:284
void block__set_min_output_buffer(int port, long size)
Definition: block_gateway.h:143
void block__set_tag_propagation_policy(block::tag_propagation_policy_t p)
Definition: block_gateway.h:192
uint64_t block__nitems_written(unsigned int which_output)
Definition: block_gateway.h:182
void block__consume_each(int how_many_items)
Definition: block_gateway.h:160
void block__set_fixed_rate(bool fixed_rate)
Definition: block_gateway.h:131
bool has_msg_handler(pmt::pmt_t which_port)
Tests if there is a handler attached to port which_port.
Definition: block_gateway.h:297
void block__consume(int which_input, int how_many_items)
Definition: block_gateway.h:155
pmt::pmt_t block__message_ports_in()
Definition: block_gateway.h:280
boost::shared_ptr< block_gateway > sptr
Definition: block_gateway.h:101
void block__set_output_multiple(int multiple)
Definition: block_gateway.h:138
void block__produce(int which_output, int how_many_items)
Definition: block_gateway.h:165
The abstract base class for all 'terminal' processing blocks.
Definition: block.h:66
void consume_each(int how_many_items)
Tell the scheduler how_many_items were consumed on each input stream.
uint64_t nitems_read(unsigned int which_input)
Return the number of items read on input stream which_input.
double relative_rate() const
return the approximate output rate / input rate
Definition: block.h:287
void consume(int which_input, int how_many_items)
Tell the scheduler how_many_items of input stream which_input were consumed.
void set_tag_propagation_policy(tag_propagation_policy_t p)
Set the policy by the scheduler to determine how tags are moved downstream.
tag_propagation_policy_t tag_propagation_policy()
Asks for the policy used by the scheduler to moved tags downstream.
void set_output_multiple(int multiple)
Constrain the noutput_items argument passed to forecast and general_work.
uint64_t nitems_written(unsigned int which_output)
Return the number of items written on output stream which_output.
void add_item_tag(unsigned int which_output, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
Adds a new tag onto the given output buffer.
Definition: block.h:707
int output_multiple() const
Definition: block.h:213
void set_min_output_buffer(long min_output_buffer)
Request limit on the minimum buffer size on all output ports.
void get_tags_in_range(std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end)
Given a [start,end), returns a vector of all tags in the range.
unsigned history() const
void produce(int which_output, int how_many_items)
Tell the scheduler how_many_items were produced on output stream which_output.
void set_fixed_rate(bool fixed_rate)
Definition: block.h:695
bool fixed_rate() const
Return true if this block has a fixed input to output rate.
Definition: block.h:141
tag_propagation_policy_t
enum to represent different tag propagation policies.
Definition: block.h:74
void get_tags_in_window(std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end)
Gets all tags within the relative window of the current call to work.
void set_history(unsigned history)
void set_relative_rate(double relative_rate)
Set the approximate output rate / input rate.
base class for evaluating a function: long -> long
Definition: feval.h:105
base class for evaluating a function: pmt -> void
Definition: feval.h:163
boost::shared_ptr< io_signature > sptr
Definition: io_signature.h:46
abstract class of message handlers
Definition: msg_handler.h:39
thread-safe message queue
Definition: msg_queue.h:37
#define GR_RUNTIME_API
Definition: gnuradio-runtime/include/gnuradio/api.h:30
static purpose_t msg
Definition: source_logger.h:39
Include this header to use the message passing features.
Definition: basic_block.h:45
tag_propagation_policy_t
Definition: block_gateway.h:46
@ TPP_DONT
Definition: block_gateway.h:47
@ TPP_ONE_TO_ONE
Definition: block_gateway.h:49
@ TPP_CUSTOM
Definition: block_gateway.h:50
@ TPP_ALL_TO_ALL
Definition: block_gateway.h:48
block_gw_work_return_type
Magic return values from general_work, gr::block::WORK_CALLED_PRODUCE.
Definition: block_gateway.h:45
@ WORK_CALLED_PRODUCE
Definition: block_gateway.h:45
@ WORK_DONE
Definition: block_gateway.h:45
block_gw_work_type
Definition: block_gateway.h:37
@ GR_BLOCK_GW_WORK_DECIM
Definition: block_gateway.h:40
@ GR_BLOCK_GW_WORK_INTERP
Definition: block_gateway.h:41
@ GR_BLOCK_GW_WORK_GENERAL
Definition: block_gateway.h:38
@ GR_BLOCK_GW_WORK_SYNC
Definition: block_gateway.h:39
boost::intrusive_ptr< pmt_base > pmt_t
typedef for shared pointer (transparent reference counting). See http://www.boost....
Definition: pmt.h:56
#define PMT_F
Definition: pmt.h:105
Definition: block_gateway.h:57
int general_work_args_return_value
Definition: block_gateway.h:73
std::vector< int > forecast_args_ninput_items_required
Definition: block_gateway.h:83
int work_args_ninput_items
Definition: block_gateway.h:75
int forecast_args_noutput_items
Definition: block_gateway.h:82
int work_args_noutput_items
Definition: block_gateway.h:76
std::vector< void * > general_work_args_input_items
Definition: block_gateway.h:70
bool stop_args_return_value
Definition: block_gateway.h:87
std::vector< void * > work_args_output_items
Definition: block_gateway.h:79
action_type action
Definition: block_gateway.h:66
int work_args_return_value
Definition: block_gateway.h:80
std::vector< void * > work_args_input_items
Definition: block_gateway.h:77
bool start_args_return_value
Definition: block_gateway.h:85
action_type
Definition: block_gateway.h:58
@ ACTION_START
Definition: block_gateway.h:62
@ ACTION_WORK
Definition: block_gateway.h:60
@ ACTION_STOP
Definition: block_gateway.h:63
@ ACTION_FORECAST
Definition: block_gateway.h:61
@ ACTION_GENERAL_WORK
Definition: block_gateway.h:59
int general_work_args_noutput_items
Definition: block_gateway.h:68
std::vector< int > general_work_args_ninput_items
Definition: block_gateway.h:69
std::vector< void * > general_work_args_output_items
Definition: block_gateway.h:72
Definition: tags.h:31