diff options
| author | Ben Reynwar <ben@reynwar.net> | 2013-05-19 02:55:33 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2013-05-19 02:55:33 -0700 |
| commit | bb01988e75d50d82cbb44c1a49c86c1d08f05665 (patch) | |
| tree | 0528dac14476d37f2cde7374a8fcb3428f879c69 /gnuradio-runtime/include/gnuradio/sync_block.h | |
| parent | e4f0319eced22c112f7e6a4cc45bc2036d285332 (diff) | |
| parent | 0fa219774dcf9141ae91204f948c029b05673f3f (diff) | |
Merged in next_docs branch.
Diffstat (limited to 'gnuradio-runtime/include/gnuradio/sync_block.h')
| -rw-r--r-- | gnuradio-runtime/include/gnuradio/sync_block.h | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/gnuradio-runtime/include/gnuradio/sync_block.h b/gnuradio-runtime/include/gnuradio/sync_block.h new file mode 100644 index 0000000000..4b0022ab7e --- /dev/null +++ b/gnuradio-runtime/include/gnuradio/sync_block.h @@ -0,0 +1,69 @@ +/* -*- c++ -*- */ +/* + * Copyright 2004,2013 Free Software Foundation, Inc. + * + * This file is part of GNU Radio + * + * GNU Radio is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3, or (at your option) + * any later version. + * + * GNU Radio is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with GNU Radio; see the file COPYING. If not, write to + * the Free Software Foundation, Inc., 51 Franklin Street, + * Boston, MA 02110-1301, USA. + */ + +#ifndef INCLUDED_GR_RUNTIME_SYNC_BLOCK_H +#define INCLUDED_GR_RUNTIME_SYNC_BLOCK_H + +#include <gnuradio/api.h> +#include <gnuradio/block.h> + +namespace gr { + + /*! + * \brief synchronous 1:1 input to output with history + * \ingroup base_blk + * + * Override work to provide the signal processing implementation. + */ + class GR_RUNTIME_API sync_block : public block + { + protected: + sync_block(void) {} // allows pure virtual interface sub-classes + sync_block(const std::string &name, + gr::io_signature::sptr input_signature, + gr::io_signature::sptr output_signature); + + public: + /*! + * \brief just like gr::block::general_work, only this arranges to + * call consume_each for you + * + * The user must override work to define the signal processing code + */ + virtual int work(int noutput_items, + gr_vector_const_void_star &input_items, + gr_vector_void_star &output_items) = 0; + + // gr::sync_block overrides these to assist work + void forecast(int noutput_items, gr_vector_int &ninput_items_required); + int general_work(int noutput_items, + gr_vector_int &ninput_items, + gr_vector_const_void_star &input_items, + gr_vector_void_star &output_items); + + int fixed_rate_ninput_to_noutput(int ninput); + int fixed_rate_noutput_to_ninput(int noutput); + }; + +} /* namespace gr */ + +#endif /* INCLUDED_GR_RUNTIME_SYNC_BLOCK_H */ |