gr-baz Package

baz_depuncture_ff.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/*
24 * gr-baz by Balint Seeber (http://spench.net/contact)
25 * Information, documentation & samples: http://wiki.spench.net/wiki/gr-baz
26 */
27
28#ifndef INCLUDED_BAZ_DEPUNCTURE_FF_H
29#define INCLUDED_BAZ_DEPUNCTURE_FF_H
30
31#include <gnuradio/block.h>
32#include <boost/thread.hpp>
33
34 class BAZ_API baz_depuncture_ff;
35
36/*
37 * We use boost::shared_ptr's instead of raw pointers for all access
38 * to gr::blocks (and many other data structures). The shared_ptr gets
39 * us transparent reference counting, which greatly simplifies storage
40 * management issues. This is especially helpful in our hybrid
41 * C++ / Python system.
42 *
43 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
44 *
45 * As a convention, the _sptr suffix indicates a boost::shared_ptr
46 */
47 typedef boost::shared_ptr<baz_depuncture_ff> baz_depuncture_ff_sptr;
48
49/*!
50 * \brief Return a shared_ptr to a new instance of baz_depuncture_ff.
51 *
52 * To avoid accidental use of raw pointers, baz_depuncture_ff's
53 * constructor is private. baz_make_depuncture_ff is the public
54 * interface for creating new instances.
55 */
56 BAZ_API baz_depuncture_ff_sptr baz_make_depuncture_ff (const std::vector<int>& matrix);
57
58/*!
59 * \brief square a stream of floats.
60 * \ingroup block
61 *
62 * \sa howto_square2_ff for a version that subclasses gr::sync_block.
63 */
64 class BAZ_API baz_depuncture_ff : public gr::block
65{
66 private:
67 // The friend declaration allows baz_make_depuncture_ff to
68 // access the private constructor.
69
70 friend BAZ_API baz_depuncture_ff_sptr baz_make_depuncture_ff (const std::vector<int>& matrix);
71
72 baz_depuncture_ff (const std::vector<int> matrix); // private constructor
73
74 boost::mutex d_mutex;
75 char* m_pMatrix;
76 int m_iLength;
77 int m_iIndex;
78
79 public:
80 ~baz_depuncture_ff (); // public destructor
81
82 void set_matrix(const std::vector<int>& matrix);
83
84 void forecast(int noutput_items, gr_vector_int &ninput_items_required);
85
86 int general_work (int noutput_items,
87 gr_vector_int &ninput_items,
88 gr_vector_const_void_star &input_items,
89 gr_vector_void_star &output_items);
90};
91
92#endif /* INCLUDED_BAZ_DEPUNCTURE_FF_H */
BAZ_API
#define BAZ_API
Definition: api.h:19
baz_depuncture_ff
class BAZ_API baz_depuncture_ff
Definition: baz_depuncture_ff.h:34
baz_make_depuncture_ff
BAZ_API baz_depuncture_ff_sptr baz_make_depuncture_ff(const std::vector< int > &matrix)
Return a shared_ptr to a new instance of baz_depuncture_ff.
baz_depuncture_ff
square a stream of floats.
Definition: baz_depuncture_ff.h:65
baz_depuncture_ff::~baz_depuncture_ff
~baz_depuncture_ff()
baz_depuncture_ff::forecast
void forecast(int noutput_items, gr_vector_int &ninput_items_required)
baz_depuncture_ff::general_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)
baz_depuncture_ff::set_matrix
void set_matrix(const std::vector< int > &matrix)
baz_depuncture_ff::baz_make_depuncture_ff
friend BAZ_API baz_depuncture_ff_sptr baz_make_depuncture_ff(const std::vector< int > &matrix)
Return a shared_ptr to a new instance of baz_depuncture_ff.