 |
GNU Radio Manual and C++ API Reference
3.9.1.0
The Free & Open Software Radio Ecosystem
|
|
Go to the documentation of this file.
11 #ifndef INCLUDED_GR_RUNTIME_BLOCK_H
12 #define INCLUDED_GR_RUNTIME_BLOCK_H
90 unsigned history()
const;
91 void set_history(
unsigned history);
112 void declare_sample_delay(
int which,
unsigned delay);
118 void declare_sample_delay(
unsigned delay);
128 unsigned sample_delay(
int which)
const;
151 virtual void forecast(
int noutput_items,
gr_vector_int& ninput_items_required);
176 virtual int general_work(
int noutput_items,
189 virtual bool start();
206 void set_output_multiple(
int multiple);
227 void set_alignment(
int multiple);
230 void set_unaligned(
int na);
232 void set_is_unaligned(
bool u);
244 void consume(
int which_input,
int how_many_items);
252 void consume_each(
int how_many_items);
265 void produce(
int which_output,
int how_many_items);
276 void set_relative_rate(
double relative_rate);
286 void set_inverse_relative_rate(
double inverse_relative_rate);
297 void set_relative_rate(uint64_t interpolation, uint64_t decimation);
310 return (uint64_t)d_mp_relative_rate.get_num().get_ui();
319 return (uint64_t)d_mp_relative_rate.get_den().get_ui();
340 virtual int fixed_rate_ninput_to_noutput(
int ninput);
347 virtual int fixed_rate_noutput_to_ninput(
int noutput);
352 uint64_t nitems_read(
unsigned int which_input);
357 uint64_t nitems_written(
unsigned int which_output);
362 tag_propagation_policy_t tag_propagation_policy();
367 void set_tag_propagation_policy(tag_propagation_policy_t p);
390 int max_noutput_items();
398 void set_max_noutput_items(
int m);
415 void unset_max_noutput_items();
421 bool is_set_max_noutput_items();
430 void expand_minmax_buffer(
int port);
435 long max_output_buffer(
size_t i);
453 void set_max_output_buffer(
long max_output_buffer);
472 void set_max_output_buffer(
int port,
long max_output_buffer);
477 long min_output_buffer(
size_t i);
496 void set_min_output_buffer(
long min_output_buffer);
515 void set_min_output_buffer(
int port,
long min_output_buffer);
522 float pc_noutput_items();
527 float pc_noutput_items_avg();
532 float pc_noutput_items_var();
537 float pc_nproduced();
542 float pc_nproduced_avg();
547 float pc_nproduced_var();
552 float pc_input_buffers_full(
int which);
557 float pc_input_buffers_full_avg(
int which);
562 float pc_input_buffers_full_var(
int which);
567 std::vector<float> pc_input_buffers_full();
572 std::vector<float> pc_input_buffers_full_avg();
577 std::vector<float> pc_input_buffers_full_var();
582 float pc_output_buffers_full(
int which);
587 float pc_output_buffers_full_avg(
int which);
592 float pc_output_buffers_full_var(
int which);
597 std::vector<float> pc_output_buffers_full();
602 std::vector<float> pc_output_buffers_full_avg();
607 std::vector<float> pc_output_buffers_full_var();
612 float pc_work_time();
617 float pc_work_time_avg();
622 float pc_work_time_var();
627 float pc_work_time_total();
632 float pc_throughput_avg();
637 void reset_perf_counters();
666 void set_processor_affinity(
const std::vector<int>& mask)
override;
671 void unset_processor_affinity()
override;
681 int active_thread_priority();
693 bool update_rate()
const;
719 void set_log_level(std::string level)
override;
724 std::string log_level()
override;
732 int d_output_multiple;
733 bool d_output_multiple_set;
736 double d_relative_rate;
737 mpq_class d_mp_relative_rate;
738 block_detail_sptr d_detail;
740 unsigned d_attr_delay;
742 bool d_max_noutput_items_set;
743 int d_max_noutput_items;
744 int d_min_noutput_items;
745 tag_propagation_policy_t
746 d_tag_propagation_policy;
747 std::vector<int> d_affinity;
755 block(
const std::string& name,
782 this->add_item_tag(which_output, tag);
791 void add_item_tag(
unsigned int which_output,
const tag_t& tag);
816 this->remove_item_tag(which_input, tag);
825 void remove_item_tag(
unsigned int which_input,
const tag_t& tag);
840 void get_tags_in_range(std::vector<tag_t>&
v,
841 unsigned int which_input,
860 void get_tags_in_range(std::vector<tag_t>&
v,
861 unsigned int which_input,
887 void get_tags_in_window(std::vector<tag_t>&
v,
888 unsigned int which_input,
904 void get_tags_in_window(std::vector<tag_t>&
v,
905 unsigned int which_input,
910 void enable_update_rate(
bool en);
934 block_detail_sptr
detail()
const {
return d_detail; }
935 void set_detail(block_detail_sptr detail) { d_detail = detail; }
939 void notify_msg_neighbors();
945 std::string identifier()
const;
951 inline block_sptr cast_to_block_sptr(basic_block_sptr p)
953 return std::dynamic_pointer_cast<block, basic_block>(p);
void set_fixed_rate(bool fixed_rate)
Definition: block.h:759
block_detail_sptr detail() const
Definition: block.h:934
bool fixed_rate() const
Return true if this block has a fixed input to output rate.
Definition: block.h:135
void set_detail(block_detail_sptr detail)
Definition: block.h:935
gr::thread::mutex d_setlock
Definition: block.h:920
mpq_class & mp_relative_rate()
return a reference to the multiple precision rational representation of the approximate output rate /...
Definition: block.h:326
uint64_t relative_rate_i() const
return the numerator, or interpolation rate, of the approximate output rate / input rate
Definition: block.h:308
std::vector< int > processor_affinity() override
Get the current processor affinity.
Definition: block.h:676
int output_multiple() const
Definition: block.h:207
std::vector< block_sptr >::iterator block_viter_t
Definition: block.h:949
bool output_multiple_set() const
Definition: block.h:208
uint64_t offset
the item tag occurred at (as a uint64_t)
Definition: tags.h:21
const pmt::pmt_t d_system_port
Definition: block.h:931
std::vector< int > gr_vector_int
Definition: types.h:23
pmt::pmt_t key
the key of tag (as a PMT symbol)
Definition: tags.h:24
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:771
std::vector< long > d_max_output_buffer
Definition: block.h:912
bool is_unaligned() const
Definition: block.h:233
std::vector< block_sptr > block_vector_t
Definition: block.h:948
block(void)
Definition: block.h:754
Definition: cc_common.h:35
GR_RUNTIME_API int set_thread_priority(gr_thread_t thread, int priority)
set current thread priority for a given thread ID
pmt::pmt_t value
the value of tag (as a PMT)
Definition: tags.h:27
std::vector< long > d_min_output_buffer
Definition: block.h:913
#define GR_RUNTIME_API
Definition: gnuradio-runtime/include/gnuradio/api.h:18
boost::mutex mutex
Definition: thread.h:37
void clear_finished()
Make sure we don't think we are finished.
Definition: block.h:943
bool is_pc_rpc_set()
Checks if this block is already exporting perf. counters to ControlPort.
Definition: block.h:649
The abstract base class for all 'terminal' processing blocks.
Definition: block.h:59
std::vector< const void * > gr_vector_const_void_star
Definition: types.h:28
work_return_t
Magic return values from general_work.
Definition: block.h:63
The abstract base class for all signal processing blocks.
Definition: basic_block.h:42
void set_min_noutput_items(int m)
Set the minimum number of output items this block can produce during a call to work.
Definition: block.h:384
#define PMT_F
Definition: pmt.h:124
int unaligned() const
Definition: block.h:231
std::shared_ptr< pmt_base > pmt_t
typedef for shared pointer (transparent reference counting).
Definition: pmt.h:84
int min_noutput_items() const
Return the minimum number of output items this block can produce during a call to work.
Definition: block.h:376
const pmt::pmt_t d_pmt_done
Definition: block.h:927
int alignment() const
Definition: block.h:228
pmt::pmt_t srcid
the source ID of tag (as a PMT)
Definition: tags.h:30
uint64_t relative_rate_d() const
return the denominator, or decimation rate, of the approximate output rate / input rate
Definition: block.h:317
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition: basic_block.h:29
tag_propagation_policy_t
enum to represent different tag propagation policies.
Definition: block.h:68
void remove_item_tag(unsigned int which_input, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
DEPRECATED. Will be removed in 3.8.
Definition: block.h:805
std::shared_ptr< io_signature > sptr
Definition: io_signature.h:34
double relative_rate() const
return the approximate output rate / input rate
Definition: block.h:302
std::ostream & operator<<(std::ostream &os, basic_block_sptr basic_block)
Definition: basic_block.h:407
GR_RUNTIME_API int thread_priority(gr_thread_t thread)
get current thread priority for a given thread ID
void no_pc_rpc()
If the block calls this in its constructor, it's perf. counters will not be exported.
Definition: block.h:655
std::vector< void * > gr_vector_void_star
Definition: types.h:27