summaryrefslogtreecommitdiff
path: root/include/gnuradio/gr_sync_block.h
blob: 335840ed8bf39886fda116fabb7cc1263daa4aed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
//
// Copyright 2012 Josh Blum
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with io_sig program.  If not, see <http://www.gnu.org/licenses/>.

#ifndef INCLUDED_GNURADIO_GR_SYNC_BLOCK_H
#define INCLUDED_GNURADIO_GR_SYNC_BLOCK_H

#include <gnuradio/runtime_api.h>
#include <gr_block.h>

struct GR_RUNTIME_API gr_sync_block : gr_block
{

    gr_sync_block(void);

    gr_sync_block(
        const std::string &name,
        gr_io_signature_sptr input_signature,
        gr_io_signature_sptr output_signature
    );

    //! implements work -> calls work
    int general_work (int noutput_items,
                gr_vector_int &ninput_items,
                gr_vector_const_void_star &input_items,
                gr_vector_void_star &output_items);
    void forecast (int noutput_items, gr_vector_int &ninput_items_required);

    void set_alignment(const size_t alignment);
    bool is_unaligned(void);

   /*!
    * \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;

};

#endif /*INCLUDED_GNURADIO_GR_SYNC_BLOCK_H*/