GNU Radio 3.5.1 C++ API
trellis_constellation_metrics_cf Class Reference

Evaluate metrics for use by the Viterbi algorithm. More...

#include <trellis_constellation_metrics_cf.h>

Inheritance diagram for trellis_constellation_metrics_cf:

List of all members.

Public Member Functions

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

Protected Member Functions

 trellis_constellation_metrics_cf (digital_constellation_sptr constellation, trellis_metric_type_t TYPE)

Friends

TRELLIS_API
trellis_constellation_metrics_cf_sptr 
trellis_make_constellation_metrics_cf (digital_constellation_sptr constellation, trellis_metric_type_t TYPE)

Detailed Description

Evaluate metrics for use by the Viterbi algorithm.


Constructor & Destructor Documentation

trellis_constellation_metrics_cf::trellis_constellation_metrics_cf ( digital_constellation_sptr  constellation,
trellis_metric_type_t  TYPE 
) [protected]

Member Function Documentation

void trellis_constellation_metrics_cf::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 trellis_constellation_metrics_cf::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

TRELLIS_API trellis_constellation_metrics_cf_sptr trellis_make_constellation_metrics_cf ( digital_constellation_sptr  constellation,
trellis_metric_type_t  TYPE 
) [friend]

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