GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
sync_block.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2013 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23#ifndef INCLUDED_GR_RUNTIME_SYNC_BLOCK_H
24#define INCLUDED_GR_RUNTIME_SYNC_BLOCK_H
25
26#include <gnuradio/api.h>
27#include <gnuradio/block.h>
28
29namespace gr {
30
31/*!
32 * \brief synchronous 1:1 input to output with history
33 * \ingroup base_blk
34 *
35 * Override work to provide the signal processing implementation.
36 */
38{
39protected:
40 sync_block(void) {} // allows pure virtual interface sub-classes
41 sync_block(const std::string& name,
42 gr::io_signature::sptr input_signature,
43 gr::io_signature::sptr output_signature);
44
45public:
46 /*!
47 * \brief just like gr::block::general_work, only this arranges to
48 * call consume_each for you
49 *
50 * The user must override work to define the signal processing code
51 */
52 virtual int work(int noutput_items,
53 gr_vector_const_void_star& input_items,
54 gr_vector_void_star& output_items) = 0;
55
56 // gr::sync_block overrides these to assist work
57 void forecast(int noutput_items, gr_vector_int& ninput_items_required);
58 int general_work(int noutput_items,
59 gr_vector_int& ninput_items,
60 gr_vector_const_void_star& input_items,
61 gr_vector_void_star& output_items);
62
65};
66
67} /* namespace gr */
68
69#endif /* INCLUDED_GR_RUNTIME_SYNC_BLOCK_H */
The abstract base class for all 'terminal' processing blocks.
Definition block.h:72
boost::shared_ptr< io_signature > sptr
Definition io_signature.h:46
synchronous 1:1 input to output with history
Definition sync_block.h:38
sync_block(const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
sync_block(void)
Definition sync_block.h:40
void forecast(int noutput_items, gr_vector_int &ninput_items_required)
Estimate input requirements given output request.
virtual int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)=0
just like gr::block::general_work, only this arranges to call consume_each for you
int fixed_rate_noutput_to_ninput(int noutput)
Given noutput samples, return number of input samples required to produce noutput....
int fixed_rate_ninput_to_noutput(int ninput)
Given ninput samples, return number of output samples that will be produced. N.B. this is only define...
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
#define GR_RUNTIME_API
Definition gnuradio-runtime/include/gnuradio/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46
std::vector< const void * > gr_vector_const_void_star
Definition types.h:40
std::vector< void * > gr_vector_void_star
Definition types.h:39
std::vector< int > gr_vector_int
Definition types.h:35