gr::block_gateway Class Reference

#include <block_gateway.h>

Inheritance diagram for gr::block_gateway:

List of all members.

Public Types
typedef boost::shared_ptr < block_gateway >	sptr
Public Member Functions
virtual block_gw_message_type &	block_message (void)=0
	Provide access to the shared message object.
long	block__unique_id (void) const
std::string	block__name (void) const
unsigned	block__history (void) const
void	block__set_history (unsigned history)
void	block__set_fixed_rate (bool fixed_rate)
bool	block__fixed_rate (void) const
void	block__set_output_multiple (int multiple)
int	block__output_multiple (void) const
void	block__consume (int which_input, int how_many_items)
void	block__consume_each (int how_many_items)
void	block__produce (int which_output, int how_many_items)
void	block__set_relative_rate (double relative_rate)
double	block__relative_rate (void) const
uint64_t	block__nitems_read (unsigned int which_input)
uint64_t	block__nitems_written (unsigned int which_output)
block::tag_propagation_policy_t	block__tag_propagation_policy (void)
void	block__set_tag_propagation_policy (block::tag_propagation_policy_t p)
void	block__add_item_tag (unsigned int which_output, const tag_t &tag)
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)
std::vector< tag_t >	block__get_tags_in_range (unsigned int which_input, uint64_t abs_start, uint64_t abs_end)
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)
void	block__message_port_register_in (pmt::pmt_t port_id)
void	block__message_port_register_out (pmt::pmt_t port_id)
void	block__message_port_pub (pmt::pmt_t port_id, pmt::pmt_t msg)
void	block__message_port_sub (pmt::pmt_t port_id, pmt::pmt_t target)
void	block__message_port_unsub (pmt::pmt_t port_id, pmt::pmt_t target)
pmt::pmt_t	block__message_ports_in ()
pmt::pmt_t	block__message_ports_out ()
void	set_msg_handler_feval (pmt::pmt_t which_port, gr::feval_p *msg_handler)
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 block_gw_work_type work_type, const unsigned factor)
Protected Types
typedef std::map< pmt::pmt_t, feval_p *, pmt::comperator >	msg_handlers_feval_t
Protected Member Functions
bool	has_msg_handler (pmt::pmt_t which_port)
	Tests if there is a handler attached to port which_port.
void	dispatch_msg (pmt::pmt_t which_port, pmt::pmt_t msg)
Protected Attributes
msg_handlers_feval_t	d_msg_handlers_feval

---

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

typedef std::map<pmt::pmt_t, feval_p *, pmt::comperator> gr::block_gateway::msg_handlers_feval_t [protected]

typedef boost::shared_ptr<block_gateway> gr::block_gateway::sptr

---

Member Function Documentation

void gr::block_gateway::block__add_item_tag	(	unsigned int	which_output,
		const tag_t &	tag
	)		[inline]

References gr::block::add_item_tag().

void gr::block_gateway::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]

References gr::block::add_item_tag().

void gr::block_gateway::block__consume	(	int	which_input,
		int	how_many_items
	)		[inline]

References gr::block::consume().

void gr::block_gateway::block__consume_each

(

int

how_many_items

)

[inline]

References gr::block::consume_each().

bool gr::block_gateway::block__fixed_rate

(

void

)

const [inline]

References gr::block::fixed_rate().

std::vector<tag_t> gr::block_gateway::block__get_tags_in_range	(	unsigned int	which_input,
		uint64_t	abs_start,
		uint64_t	abs_end
	)		[inline]

References gr::block::get_tags_in_range().

std::vector<tag_t> gr::block_gateway::block__get_tags_in_range	(	unsigned int	which_input,
		uint64_t	abs_start,
		uint64_t	abs_end,
		const pmt::pmt_t &	key
	)		[inline]

References gr::block::get_tags_in_range().

unsigned gr::block_gateway::block__history

(

void

)

const [inline]

References gr::block::history().

void gr::block_gateway::block__message_port_pub	(	pmt::pmt_t	port_id,
		pmt::pmt_t	msg
	)		[inline]

References gr::basic_block::message_port_pub().

void gr::block_gateway::block__message_port_register_in

(

pmt::pmt_t

port_id

)

[inline]

References gr::basic_block::message_port_register_in().

void gr::block_gateway::block__message_port_register_out

(

pmt::pmt_t

port_id

)

[inline]

References gr::basic_block::message_port_register_out().

void gr::block_gateway::block__message_port_sub	(	pmt::pmt_t	port_id,
		pmt::pmt_t	target
	)		[inline]

References gr::basic_block::message_port_sub().

void gr::block_gateway::block__message_port_unsub	(	pmt::pmt_t	port_id,
		pmt::pmt_t	target
	)		[inline]

References gr::basic_block::message_port_unsub().

pmt::pmt_t gr::block_gateway::block__message_ports_in

(

)

[inline]

References gr::basic_block::message_ports_in().

pmt::pmt_t gr::block_gateway::block__message_ports_out

(

)

[inline]

References gr::basic_block::message_ports_out().

std::string gr::block_gateway::block__name

(

void

)

const [inline]

References gr::basic_block::name().

uint64_t gr::block_gateway::block__nitems_read

(

unsigned int

which_input

)

[inline]

References gr::block::nitems_read().

uint64_t gr::block_gateway::block__nitems_written

(

unsigned int

which_output

)

[inline]

References gr::block::nitems_written().

int gr::block_gateway::block__output_multiple

(

void

)

const [inline]

References gr::block::output_multiple().

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

References gr::block::produce().

double gr::block_gateway::block__relative_rate

(

void

)

const [inline]

References gr::block::relative_rate().

void gr::block_gateway::block__set_fixed_rate

(

bool

fixed_rate

)

[inline]

References gr::block::set_fixed_rate().

void gr::block_gateway::block__set_history

(

unsigned

history

)

[inline]

References gr::block::set_history().

void gr::block_gateway::block__set_output_multiple

(

int

multiple

)

[inline]

References gr::block::set_output_multiple().

void gr::block_gateway::block__set_relative_rate

(

double

relative_rate

)

[inline]

References gr::block::set_relative_rate().

void gr::block_gateway::block__set_tag_propagation_policy

(

block::tag_propagation_policy_t

p

)

[inline]

References gr::block::set_tag_propagation_policy().

block::tag_propagation_policy_t gr::block_gateway::block__tag_propagation_policy

(

void

)

[inline]

References gr::block::tag_propagation_policy().

long gr::block_gateway::block__unique_id

(

void

)

const [inline]

References gr::basic_block::unique_id().

virtual block_gw_message_type& gr::block_gateway::block_message

(

void

)

[pure virtual]

Provide access to the shared message object.

void gr::block_gateway::dispatch_msg	(	pmt::pmt_t	which_port,
		pmt::pmt_t	msg
	)		[inline, protected, virtual]

Reimplemented from gr::basic_block.

References gr::basic_block::dispatch_msg().

bool gr::block_gateway::has_msg_handler

(

pmt::pmt_t

which_port

)

[inline, protected, virtual]

Tests if there is a handler attached to port which_port.

Reimplemented from gr::basic_block.

static sptr gr::block_gateway::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
	)		[static]

Make a new gateway block.

Parameters:

handler	the swig director object with callback
name	the name of the block (Ex: "Shirley")
in_sig	the input signature for this block
out_sig	the output signature for this block
work_type	the type of block overload to implement
factor	the decimation or interpolation factor

Returns:

a new gateway block

void gr::block_gateway::set_msg_handler_feval	(	pmt::pmt_t	which_port,
		gr::feval_p *	msg_handler
	)		[inline]

---

Member Data Documentation

msg_handlers_feval_t gr::block_gateway::d_msg_handlers_feval [protected]

---

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

• block_gateway.h