GNU Radio 3.7.0-50 C++ API
block_gateway.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2011-2013 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 
30 namespace 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  /*!
45  * Shared message structure between python and gateway.
46  * Each action type represents a scheduler-called function.
47  */
49  enum action_type {
50  ACTION_GENERAL_WORK, //dispatch work
51  ACTION_WORK, //dispatch work
52  ACTION_FORECAST, //dispatch forecast
53  ACTION_START, //dispatch start
54  ACTION_STOP, //dispatch stop
55  };
56 
58 
61  std::vector<void *> general_work_args_input_items; //TODO this should be const void*, but swig cant int cast it right
62  std::vector<void *> general_work_args_output_items;
64 
67  std::vector<void *> work_args_input_items; //TODO this should be const void*, but swig cant int cast it right
68  std::vector<void *> work_args_output_items;
70 
73 
75 
77  };
78 
79  /*!
80  * The gateway block which performs all the magic.
81  *
82  * The gateway provides access to all the gr::block routines.
83  * The methods prefixed with gr::block__ are renamed
84  * to class methods without the prefix in python.
85  */
86  class GR_RUNTIME_API block_gateway : virtual public gr::block
87  {
88  public:
89  // gr::block_gateway::sptr
91 
92  /*!
93  * Make a new gateway block.
94  * \param handler the swig director object with callback
95  * \param name the name of the block (Ex: "Shirley")
96  * \param in_sig the input signature for this block
97  * \param out_sig the output signature for this block
98  * \param work_type the type of block overload to implement
99  * \param factor the decimation or interpolation factor
100  * \return a new gateway block
101  */
102  static sptr make(gr::feval_ll *handler,
103  const std::string &name,
104  gr::io_signature::sptr in_sig,
105  gr::io_signature::sptr out_sig,
106  const block_gw_work_type work_type,
107  const unsigned factor);
108 
109  //! Provide access to the shared message object
110  virtual block_gw_message_type &block_message(void) = 0;
111 
112  long block__unique_id(void) const {
113  return gr::block::unique_id();
114  }
115 
116  std::string block__name(void) const {
117  return gr::block::name();
118  }
119 
120  unsigned block__history(void) const {
121  return gr::block::history();
122  }
123 
124  void block__set_history(unsigned history) {
125  return gr::block::set_history(history);
126  }
127 
128  void block__set_fixed_rate(bool fixed_rate) {
129  return gr::block::set_fixed_rate(fixed_rate);
130  }
131 
132  bool block__fixed_rate(void) const {
133  return gr::block::fixed_rate();
134  }
135 
136  void block__set_output_multiple(int multiple) {
137  return gr::block::set_output_multiple(multiple);
138  }
139 
140  int block__output_multiple(void) const {
142  }
143 
144  void block__consume(int which_input, int how_many_items) {
145  return gr::block::consume(which_input, how_many_items);
146  }
147 
148  void block__consume_each(int how_many_items) {
149  return gr::block::consume_each(how_many_items);
150  }
151 
152  void block__produce(int which_output, int how_many_items) {
153  return gr::block::produce(which_output, how_many_items);
154  }
155 
156  void block__set_relative_rate(double relative_rate) {
157  return gr::block::set_relative_rate(relative_rate);
158  }
159 
160  double block__relative_rate(void) const {
161  return gr::block::relative_rate();
162  }
163 
164  uint64_t block__nitems_read(unsigned int which_input) {
165  return gr::block::nitems_read(which_input);
166  }
167 
168  uint64_t block__nitems_written(unsigned int which_output) {
169  return gr::block::nitems_written(which_output);
170  }
171 
174  }
175 
178  }
179 
180  void block__add_item_tag(unsigned int which_output,
181  const tag_t &tag)
182  {
183  return gr::block::add_item_tag(which_output, tag);
184  }
185 
186  void block__add_item_tag(unsigned int which_output,
187  uint64_t abs_offset,
188  const pmt::pmt_t &key,
189  const pmt::pmt_t &value,
190  const pmt::pmt_t &srcid=pmt::PMT_F)
191  {
192  return gr::block::add_item_tag(which_output, abs_offset,
193  key, value, srcid);
194  }
195 
196  std::vector<tag_t> block__get_tags_in_range(unsigned int which_input,
197  uint64_t abs_start,
198  uint64_t abs_end)
199  {
200  std::vector<gr::tag_t> tags;
201  gr::block::get_tags_in_range(tags, which_input, abs_start, abs_end);
202  return tags;
203  }
204 
205  std::vector<tag_t> block__get_tags_in_range(unsigned int which_input,
206  uint64_t abs_start,
207  uint64_t abs_end,
208  const pmt::pmt_t &key)
209  {
210  std::vector<gr::tag_t> tags;
211  gr::block::get_tags_in_range(tags, which_input, abs_start, abs_end, key);
212  return tags;
213  }
214 
215  /* Message passing interface */
218  }
219 
222  }
223 
225  gr::basic_block::message_port_pub(port_id, msg);
226  }
227 
229  gr::basic_block::message_port_sub(port_id, target);
230  }
231 
233  gr::basic_block::message_port_unsub(port_id, target);
234  }
235 
238  }
239 
242  }
243 
244  void set_msg_handler_feval(pmt::pmt_t which_port, gr::feval_p *msg_handler)
245  {
246  if(msg_queue.find(which_port) == msg_queue.end()) {
247  throw std::runtime_error("attempt to set_msg_handler_feval() on bad input message port!");
248  }
249  d_msg_handlers_feval[which_port] = msg_handler;
250  }
251 
252  protected:
253  typedef std::map<pmt::pmt_t, feval_p *, pmt::comperator> msg_handlers_feval_t;
255 
256  bool has_msg_handler(pmt::pmt_t which_port)
257  {
258  return (d_msg_handlers_feval.find(which_port) != d_msg_handlers_feval.end());
259  }
260 
261  void dispatch_msg(pmt::pmt_t which_port, pmt::pmt_t msg)
262  {
263  // Is there a handler?
264  if(d_msg_handlers_feval.find(which_port) != d_msg_handlers_feval.end()) {
265  d_msg_handlers_feval[which_port]->calleval(msg); // Yes, invoke it.
266  }
267  else {
268  // Pass to generic dispatcher if not found
269  gr::basic_block::dispatch_msg(which_port, msg);
270  }
271  }
272  };
273 
274 } /* namespace gr */
275 
276 #endif /* INCLUDED_RUNTIME_BLOCK_GATEWAY_H */