GNU Radio 3.6.0 C++ API
block_gateway Class Reference

#include <block_gateway.h>

Inheritance diagram for block_gateway:
gr_block gr_basic_block gr_msg_accepter gruel::msg_accepter

List of all members.

Public Types

typedef boost::shared_ptr
< block_gateway
sptr

Public Member Functions

virtual gr_block_gw_message_typegr_block_message (void)=0
 Provide access to the shared message object.
long gr_block__unique_id (void) const
std::string gr_block__name (void) const
unsigned gr_block__history (void) const
void gr_block__set_history (unsigned history)
void gr_block__set_fixed_rate (bool fixed_rate)
bool gr_block__fixed_rate (void) const
void gr_block__set_output_multiple (int multiple)
int gr_block__output_multiple (void) const
void gr_block__consume (int which_input, int how_many_items)
void gr_block__consume_each (int how_many_items)
void gr_block__produce (int which_output, int how_many_items)
void gr_block__set_relative_rate (double relative_rate)
double gr_block__relative_rate (void) const
uint64_t gr_block__nitems_read (unsigned int which_input)
uint64_t gr_block__nitems_written (unsigned int which_output)
gr_block::tag_propagation_policy_t gr_block__tag_propagation_policy (void)
void gr_block__set_tag_propagation_policy (gr_block::tag_propagation_policy_t p)
void gr_block__add_item_tag (unsigned int which_output, const gr_tag_t &tag)
void gr_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)
std::vector< gr_tag_tgr_block__get_tags_in_range (unsigned int which_input, uint64_t abs_start, uint64_t abs_end)
std::vector< gr_tag_tgr_block__get_tags_in_range (unsigned int which_input, uint64_t abs_start, uint64_t abs_end, const pmt::pmt_t &key)
void gr_block__push_msg_queue (const gr_tag_t &msg)
bool gr_block__check_msg_queue (void)
gr_tag_t gr_block__pop_msg_queue (void)
void gr_block__post_msg (const std::string &group, const gr_tag_t &msg)
void gr_block__post_msg (const std::string &group, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)

Static Public Member Functions

static sptr make (gr_feval_ll *handler, const std::string &name, gr_io_signature_sptr in_sig, gr_io_signature_sptr out_sig, const gr_block_gw_work_type work_type, const unsigned factor)

Detailed Description

The gateway block which performs all the magic.

The gateway provides access to all the gr_block routines. The methods prefixed with gr_block__ are renamed to class methods without the prefix in python.


Member Typedef Documentation


Member Function Documentation

void block_gateway::gr_block__add_item_tag ( unsigned int  which_output,
const gr_tag_t tag 
) [inline]
void block_gateway::gr_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 
) [inline]
bool block_gateway::gr_block__check_msg_queue ( void  ) [inline]
void block_gateway::gr_block__consume ( int  which_input,
int  how_many_items 
) [inline]

References gr_block::consume().

void block_gateway::gr_block__consume_each ( int  how_many_items) [inline]
bool block_gateway::gr_block__fixed_rate ( void  ) const [inline]
std::vector<gr_tag_t> block_gateway::gr_block__get_tags_in_range ( unsigned int  which_input,
uint64_t  abs_start,
uint64_t  abs_end 
) [inline]
std::vector<gr_tag_t> block_gateway::gr_block__get_tags_in_range ( unsigned int  which_input,
uint64_t  abs_start,
uint64_t  abs_end,
const pmt::pmt_t key 
) [inline]
unsigned block_gateway::gr_block__history ( void  ) const [inline]

References gr_block::history().

std::string block_gateway::gr_block__name ( void  ) const [inline]
uint64_t block_gateway::gr_block__nitems_read ( unsigned int  which_input) [inline]
uint64_t block_gateway::gr_block__nitems_written ( unsigned int  which_output) [inline]
int block_gateway::gr_block__output_multiple ( void  ) const [inline]
gr_tag_t block_gateway::gr_block__pop_msg_queue ( void  ) [inline]
void block_gateway::gr_block__post_msg ( const std::string group,
const gr_tag_t msg 
) [inline]

References gr_block::post_msg().

void block_gateway::gr_block__post_msg ( const std::string group,
const pmt::pmt_t key,
const pmt::pmt_t value,
const pmt::pmt_t srcid = pmt::PMT_F 
) [inline]

References gr_block::post_msg().

void block_gateway::gr_block__produce ( int  which_output,
int  how_many_items 
) [inline]

References gr_block::produce().

void block_gateway::gr_block__push_msg_queue ( const gr_tag_t msg) [inline]
double block_gateway::gr_block__relative_rate ( void  ) const [inline]
void block_gateway::gr_block__set_fixed_rate ( bool  fixed_rate) [inline]
void block_gateway::gr_block__set_history ( unsigned  history) [inline]
void block_gateway::gr_block__set_output_multiple ( int  multiple) [inline]
void block_gateway::gr_block__set_relative_rate ( double  relative_rate) [inline]
void block_gateway::gr_block__set_tag_propagation_policy ( gr_block::tag_propagation_policy_t  p) [inline]
gr_block::tag_propagation_policy_t block_gateway::gr_block__tag_propagation_policy ( void  ) [inline]
long block_gateway::gr_block__unique_id ( void  ) const [inline]
virtual gr_block_gw_message_type& block_gateway::gr_block_message ( void  ) [pure virtual]

Provide access to the shared message object.

static sptr block_gateway::make ( gr_feval_ll handler,
const std::string name,
gr_io_signature_sptr  in_sig,
gr_io_signature_sptr  out_sig,
const gr_block_gw_work_type  work_type,
const unsigned  factor 
) [static]

Make a new gateway block.

Parameters:
handlerthe swig director object with callback
namethe name of the block (Ex: "Shirley")
in_sigthe input signature for this block
out_sigthe output signature for this block
work_typethe type of block overload to implement
factorthe decimation or interpolation factor
Returns:
a new gateway block

The documentation for this class was generated from the following file: