gr_keep_one_in_n Class Reference
[Miscellaneous]

decimate a stream, keeping one item out of every n. More...

#include <gr_keep_one_in_n.h>

Inheritance diagram for gr_keep_one_in_n:

[legend]

Collaboration diagram for gr_keep_one_in_n:

[legend]

List of all members.

Public Member Functions
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	set_n (int n)
Protected Member Functions
	gr_keep_one_in_n (size_t item_size, int n)
Friends
gr_keep_one_in_n_sptr	gr_make_keep_one_in_n (size_t item_size, int n)

---

Detailed Description

decimate a stream, keeping one item out of every n.

---

Constructor & Destructor Documentation

gr_keep_one_in_n::gr_keep_one_in_n	(	size_t	item_size,
		int	n
	)			[protected]

---

Member Function Documentation

int gr_keep_one_in_n::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.

Implements gr_block.

void gr_keep_one_in_n::set_n

(

int

n

)

---

Friends And Related Function Documentation

gr_keep_one_in_n_sptr gr_make_keep_one_in_n	(	size_t	item_size,
		int	n
	)			[friend]

---

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

• gr_keep_one_in_n.h