GNU Radio 3.5.1 C++ API
gr_align_on_samplenumbers_ss Class Reference

#include <gr_align_on_samplenumbers_ss.h>

Inheritance diagram for gr_align_on_samplenumbers_ss:

List of all members.

Classes

class  align_state

Public Member Functions

 ~gr_align_on_samplenumbers_ss ()
bool check_topology (int ninputs, int noutputs)
 Confirm that ninputs and noutputs is an acceptable combination.
void forecast (int noutput_items, gr_vector_int &ninput_items_required)
 Estimate input requirements given output request.
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

Friends

GR_CORE_API
gr_align_on_samplenumbers_ss_sptr 
gr_make_align_on_samplenumbers_ss (int nchan, int align_interval)

Constructor & Destructor Documentation

gr_align_on_samplenumbers_ss::~gr_align_on_samplenumbers_ss ( )

Member Function Documentation

bool gr_align_on_samplenumbers_ss::check_topology ( int  ninputs,
int  noutputs 
) [virtual]

Confirm that ninputs and noutputs is an acceptable combination.

Parameters:
ninputsnumber of input streams connected
noutputsnumber of output streams connected
Returns:
true if this is a valid configuration for this block.

This function is called by the runtime system whenever the topology changes. Most classes do not need to override this. This check is in addition to the constraints specified by the input and output gr_io_signatures.

Reimplemented from gr_basic_block.

void gr_align_on_samplenumbers_ss::forecast ( int  noutput_items,
gr_vector_int ninput_items_required 
) [virtual]

Estimate input requirements given output request.

Parameters:
noutput_itemsnumber of output items to produce
ninput_items_requirednumber of input items required on each input stream

Given a request to product noutput_items, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close.

Reimplemented from gr_block.

int gr_align_on_samplenumbers_ss::general_work ( int  noutput_items,
gr_vector_int ninput_items,
gr_vector_const_void_star input_items,
gr_vector_void_star output_items 
) [virtual]

compute output items from input items

Parameters:
noutput_itemsnumber of output items to write on each output stream
ninput_itemsnumber of input items available on each input stream
input_itemsvector of pointers to the input items, one entry per input stream
output_itemsvector of pointers to the output items, one entry per output stream
Returns:
number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items

general_work must call consume or consume_each to indicate how many items were consumed on each input stream.

Implements gr_block.


Friends And Related Function Documentation

GR_CORE_API gr_align_on_samplenumbers_ss_sptr gr_make_align_on_samplenumbers_ss ( int  nchan,
int  align_interval 
) [friend]

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