digital_simple_framer Class Reference

add sync field, seq number and command field to payload More...

#include <digital_simple_framer.h>

Inheritance diagram for digital_simple_framer:

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
Friends
DIGITAL_API digital_simple_framer_sptr	digital_make_simple_framer (int payload_bytesize)

---

Detailed Description

add sync field, seq number and command field to payload

Takes in enough samples to create a full output frame. The frame is prepended with the GRSF_SYNC (defind in digital_simple_framer_sync.h) and an 8-bit sequence number.

Parameters:

payload_bytesize

The size of the payload in bytes.

---

Member Function Documentation

void digital_simple_framer::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_simple_framer::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_simple_framer_sptr digital_make_simple_framer

(

int

payload_bytesize

)

[friend]

---

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

• digital_simple_framer.h