GNU Radio 3.6.3.1 C++ API
gr_ctcss_squelch_ff Class Reference

gate or zero output if ctcss tone not present More...

#include <gr_ctcss_squelch_ff.h>

Inheritance diagram for gr_ctcss_squelch_ff:
gr_squelch_base_ff gr_block gr_basic_block gr_msg_accepter gruel::msg_accepter

Public Member Functions

std::vector< float > squelch_range () const
float level () const
void set_level (float level)
int len () const
- Public Member Functions inherited from gr_squelch_base_ff
 gr_squelch_base_ff (const char *name, int ramp, bool gate)
int ramp () const
void set_ramp (int ramp)
bool gate () const
void set_gate (bool gate)
bool unmuted () const
int general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 compute output items from input items
- Public Member Functions inherited from gr_block
virtual ~gr_block ()
unsigned history () const
void set_history (unsigned history)
bool fixed_rate () const
 Return true if this block has a fixed input to output rate.
virtual void forecast (int noutput_items, gr_vector_int &ninput_items_required)
 Estimate input requirements given output request.
virtual bool start ()
 Called to enable drivers, etc for i/o devices.
virtual bool stop ()
 Called to disable drivers, etc for i/o devices.
void set_output_multiple (int multiple)
 Constrain the noutput_items argument passed to forecast and general_work.
int output_multiple () const
bool output_multiple_set () const
void set_alignment (int multiple)
 Constrains buffers to work on a set item alignment (for SIMD)
int alignment () const
void set_unaligned (int na)
int unaligned () const
void set_is_unaligned (bool u)
bool is_unaligned () const
void consume (int which_input, int how_many_items)
 Tell the scheduler how_many_items of input stream which_input were consumed.
void consume_each (int how_many_items)
 Tell the scheduler how_many_items were consumed on each input stream.
void produce (int which_output, int how_many_items)
 Tell the scheduler how_many_items were produced on output stream which_output.
void set_relative_rate (double relative_rate)
 Set the approximate output rate / input rate.
double relative_rate () const
 return the approximate output rate / input rate
virtual int fixed_rate_ninput_to_noutput (int ninput)
 Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
virtual int fixed_rate_noutput_to_ninput (int noutput)
 Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
uint64_t nitems_read (unsigned int which_input)
 Return the number of items read on input stream which_input.
uint64_t nitems_written (unsigned int which_output)
 Return the number of items written on output stream which_output.
tag_propagation_policy_t tag_propagation_policy ()
 Asks for the policy used by the scheduler to moved tags downstream.
void set_tag_propagation_policy (tag_propagation_policy_t p)
 Set the policy by the scheduler to determine how tags are moved downstream.
int max_noutput_items ()
 Return the maximum number of output items this block will handle during a call to work.
void set_max_noutput_items (int m)
 Set the maximum number of ouput items htis block will handle during a call to work.
void unset_max_noutput_items ()
 Clear the switch for using the max_noutput_items value of this block.
bool is_set_max_noutput_items ()
 Ask the block if the flag is or is not set to use the internal value of max_noutput_items during a call to work.
void expand_minmax_buffer (int port)
long max_output_buffer (size_t i)
 Returns max buffer size on output port i.
void set_max_output_buffer (long max_output_buffer)
 Sets max buffer size on all output ports.
void set_max_output_buffer (int port, long max_output_buffer)
 Sets max buffer size on output port port.
long min_output_buffer (size_t i)
 Returns min buffer size on output port i.
void set_min_output_buffer (long min_output_buffer)
 Sets min buffer size on all output ports.
void set_min_output_buffer (int port, long min_output_buffer)
 Sets min buffer size on output port port.
gr_block_detail_sptr detail () const
void set_detail (gr_block_detail_sptr detail)
- Public Member Functions inherited from gr_basic_block
virtual ~gr_basic_block ()
long unique_id () const
long symbolic_id () const
std::string name () const
std::string symbol_name () const
gr_io_signature_sptr input_signature () const
gr_io_signature_sptr output_signature () const
gr_basic_block_sptr to_basic_block ()
bool alias_set ()
std::string alias ()
pmt::pmt_t alias_pmt ()
void set_block_alias (std::string name)
void message_port_register_in (pmt::pmt_t port_id)
void message_port_register_out (pmt::pmt_t port_id)
void message_port_pub (pmt::pmt_t port_id, pmt::pmt_t msg)
void message_port_sub (pmt::pmt_t port_id, pmt::pmt_t target)
void message_port_unsub (pmt::pmt_t port_id, pmt::pmt_t target)
virtual bool message_port_is_hier (pmt::pmt_t port_id)
virtual bool message_port_is_hier_in (pmt::pmt_t port_id)
virtual bool message_port_is_hier_out (pmt::pmt_t port_id)
pmt::pmt_t message_ports_in ()
 Get input message port names.
pmt::pmt_t message_ports_out ()
 Get output message port names.
void _post (pmt::pmt_t which_port, pmt::pmt_t msg)
bool empty_p (pmt::pmt_t which_port)
 is the queue empty?
bool empty_p ()
void insert_tail (pmt::pmt_t which_port, pmt::pmt_t msg)
pmt::pmt_t delete_head_nowait (pmt::pmt_t which_port)
pmt::pmt_t delete_head_blocking (pmt::pmt_t which_port)
msg_queue_t::iterator get_iterator (pmt::pmt_t which_port)
void erase_msg (pmt::pmt_t which_port, msg_queue_t::iterator it)
virtual bool has_msg_port (pmt::pmt_t which_port)
virtual bool check_topology (int ninputs, int noutputs)
 Confirm that ninputs and noutputs is an acceptable combination.
template<typename T >
void set_msg_handler (pmt::pmt_t which_port, T msg_handler)
 Set the callback that is fired when messages are available.
- Public Member Functions inherited from gr_msg_accepter
 gr_msg_accepter ()
 ~gr_msg_accepter ()
void post (pmt::pmt_t which_port, pmt::pmt_t msg)
 send msg to msg_accepter on port which_port
- Public Member Functions inherited from gruel::msg_accepter
 msg_accepter ()
virtual ~msg_accepter ()

Protected Member Functions

virtual void update_state (const float &in)
virtual bool mute () const

Friends

GR_CORE_API
gr_ctcss_squelch_ff_sptr 
gr_make_ctcss_squelch_ff (int rate, float freq, float level, int len, int ramp, bool gate)

Additional Inherited Members

- Public Types inherited from gr_block
enum  { WORK_CALLED_PRODUCE = -2, WORK_DONE = -1 }
 Magic return values from general_work. More...
enum  tag_propagation_policy_t { TPP_DONT = 0, TPP_ALL_TO_ALL = 1, TPP_ONE_TO_ONE = 2 }
- Protected Types inherited from gr_basic_block
enum  vcolor { WHITE, GREY, BLACK }
- Protected Attributes inherited from gr_block
std::vector< long > d_max_output_buffer
std::vector< long > d_min_output_buffer

Detailed Description

gate or zero output if ctcss tone not present

Member Function Documentation

int gr_ctcss_squelch_ff::len ( ) const
inline
float gr_ctcss_squelch_ff::level ( ) const
inline
virtual bool gr_ctcss_squelch_ff::mute ( ) const
inlineprotectedvirtual

Reimplemented from gr_squelch_base_ff.

void gr_ctcss_squelch_ff::set_level ( float  level)
inline
std::vector<float> gr_ctcss_squelch_ff::squelch_range ( ) const
virtual

Implements gr_squelch_base_ff.

virtual void gr_ctcss_squelch_ff::update_state ( const float &  in)
protectedvirtual

Reimplemented from gr_squelch_base_ff.

Friends And Related Function Documentation

GR_CORE_API gr_ctcss_squelch_ff_sptr gr_make_ctcss_squelch_ff ( int  rate,
float  freq,
float  level,
int  len,
int  ramp,
bool  gate 
)
friend

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