gr-baz Package

baz_test_counter_cc.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_TEST_COUNTER_CC_H
29#define INCLUDED_BAZ_TEST_COUNTER_CC_H
30
31#include <gnuradio/sync_block.h>
32
33 class BAZ_API baz_test_counter_cc;
34
35/*
36 * We use boost::shared_ptr's instead of raw pointers for all access
37 * to gr::blocks (and many other data structures). The shared_ptr gets
38 * us transparent reference counting, which greatly simplifies storage
39 * management issues. This is especially helpful in our hybrid
40 * C++ / Python system.
41 *
42 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
43 *
44 * As a convention, the _sptr suffix indicates a boost::shared_ptr
45 */
46 typedef boost::shared_ptr<baz_test_counter_cc> baz_test_counter_cc_sptr;
47
48/*!
49 * \brief Return a shared_ptr to a new instance of baz_test_counter_cc.
50 *
51 * To avoid accidental use of raw pointers, baz_test_counter_cc's
52 * constructor is private. howto_make_square2_ff is the public
53 * interface for creating new instances.
54 */
55 BAZ_API baz_test_counter_cc_sptr baz_make_test_counter_cc ();
56
57/*!
58 * \brief square2 a stream of floats.
59 * \ingroup block
60 *
61 * This uses the preferred technique: subclassing gr::sync_block.
62 */
63 class BAZ_API baz_test_counter_cc : public gr::sync_block
64{
65 private:
66 // The friend declaration allows howto_make_square2_ff to
67 // access the private constructor.
68
69 friend BAZ_API baz_test_counter_cc_sptr baz_make_test_counter_cc ();
70
71 baz_test_counter_cc (); // private constructor
72
73 unsigned short d_counter;
74
75 public:
76 ~baz_test_counter_cc (); // public destructor
77
78 int work (int noutput_items,
79 gr_vector_const_void_star &input_items,
80 gr_vector_void_star &output_items);
81};
82
83#endif /* INCLUDED_BAZ_TEST_COUNTER_CC_H */
BAZ_API
#define BAZ_API
Definition api.h:19
baz_make_test_counter_cc
BAZ_API baz_test_counter_cc_sptr baz_make_test_counter_cc()
Return a shared_ptr to a new instance of baz_test_counter_cc.
baz_test_counter_cc
class BAZ_API baz_test_counter_cc
Definition baz_test_counter_cc.h:33
baz_test_counter_cc
square2 a stream of floats.
Definition baz_test_counter_cc.h:64
baz_test_counter_cc::baz_make_test_counter_cc
friend BAZ_API baz_test_counter_cc_sptr baz_make_test_counter_cc()
Return a shared_ptr to a new instance of baz_test_counter_cc.
baz_test_counter_cc::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
baz_test_counter_cc::~baz_test_counter_cc
~baz_test_counter_cc()