digital_ofdm_insert_preamble Class Reference

insert "pre-modulated" preamble symbols before each payload. More...

#include <digital_ofdm_insert_preamble.h>

Inheritance diagram for digital_ofdm_insert_preamble:

List of all members.

Public Member Functions
	~digital_ofdm_insert_preamble ()
void	enter_preamble ()
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
void	forecast (int noutput_items, gr_vector_int &ninput_items_required)
	Estimate input requirements given output request.
Protected Member Functions
	digital_ofdm_insert_preamble (int fft_length, const std::vector< std::vector< gr_complex > > &preamble)
Friends
DIGITAL_API digital_ofdm_insert_preamble_sptr	digital_make_ofdm_insert_preamble (int fft_length, const std::vector< std::vector< gr_complex > > &preamble)

---

Detailed Description

insert "pre-modulated" preamble symbols before each payload.

 input 1: stream of vectors of gr_complex [fft_length]
          These are the modulated symbols of the payload.

 input 2: stream of char.  The LSB indicates whether the corresponding
          symbol on input 1 is the first symbol of the payload or not.
          It's a 1 if the corresponding symbol is the first symbol,
          otherwise 0.

 N.B., this implies that there must be at least 1 symbol in the payload.

 output 1: stream of vectors of gr_complex [fft_length]
           These include the preamble symbols and the payload symbols.

 output 2: stream of char.  The LSB indicates whether the corresponding
           symbol on input 1 is the first symbol of a packet (i.e., the
           first symbol of the preamble.)   It's a 1 if the corresponding
           symbol is the first symbol, otherwise 0.
 

Parameters:

fft_length	length of each symbol in samples.
preamble	vector of symbols that represent the pre-modulated preamble.

---

Constructor & Destructor Documentation

digital_ofdm_insert_preamble::digital_ofdm_insert_preamble	(	int	fft_length,
		const std::vector< std::vector< gr_complex > > &	preamble
	)		[protected]

digital_ofdm_insert_preamble::~digital_ofdm_insert_preamble

(

)

---

Member Function Documentation

void digital_ofdm_insert_preamble::enter_preamble

(

)

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

Estimate input requirements given output request.

Parameters:

noutput_items	number of output items to produce
ninput_items_required	number 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 digital_ofdm_insert_preamble::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_items	number of output items to write on each output stream
ninput_items	number of input items available on each input stream
input_items	vector of pointers to the input items, one entry per input stream
output_items	vector 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.

Reimplemented from gr_block.

---

Friends And Related Function Documentation

DIGITAL_API digital_ofdm_insert_preamble_sptr digital_make_ofdm_insert_preamble	(	int	fft_length,
		const std::vector< std::vector< gr_complex > > &	preamble
	)		[friend]

---

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

• digital_ofdm_insert_preamble.h