gr_skiphead Class Reference
skips the first N items, from then on copies items to the output More...
#include <gr_skiphead.h>
Inheritance diagram for gr_skiphead:
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 | |
Friends | |
| GR_CORE_API gr_skiphead_sptr | gr_make_skiphead (size_t itemsize, uint64_t nitems_to_skip) |
Detailed Description
skips the first N items, from then on copies items to the output
Useful for building test cases and sources which have metadata or junk at the start
Member Function Documentation
| int gr_skiphead::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
| GR_CORE_API gr_skiphead_sptr gr_make_skiphead | ( | size_t | itemsize, |
| uint64_t | nitems_to_skip | ||
| ) | [friend] |
The documentation for this class was generated from the following file:
