gr-baz Package

baz_block_status.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_BLOCK_STATUS_H
29#define INCLUDED_BAZ_BLOCK_STATUS_H
30
31#include <gnuradio/sync_block.h>
32#include <gnuradio/msg_queue.h>
33
34 class BAZ_API baz_block_status;
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_block_status> baz_block_status_sptr;
48
49/*!
50 * \brief Return a shared_ptr to a new instance of baz_block_status.
51 *
52 * To avoid accidental use of raw pointers, baz_block_status's
53 * constructor is private. howto_make_square2_ff is the public
54 * interface for creating new instances.
55 */
56 BAZ_API baz_block_status_sptr baz_make_block_status (int size, unsigned long work_iterations, unsigned long samples_processed, gr::msg_queue::sptr queue = gr::msg_queue::sptr());
57
58/*!
59 * \brief square2 a stream of floats.
60 * \ingroup block
61 *
62 * This uses the preferred technique: subclassing gr::sync_block.
63 */
64 class BAZ_API baz_block_status : public gr::sync_block
65{
66 private:
67 // The friend declaration allows howto_make_square2_ff to
68 // access the private constructor.
69
70 friend BAZ_API baz_block_status_sptr baz_make_block_status (int size, unsigned long work_iterations, unsigned long samples_processed, gr::msg_queue::sptr queue);
71
72 baz_block_status (int size, gr::msg_queue::sptr queue, unsigned long work_iterations, unsigned long samples_processed); // private constructor
73
74 int d_size;
75 gr::msg_queue::sptr d_queue;
76 unsigned long d_work_iterations;
77 unsigned long d_samples_processed;
78
79 public:
80 ~baz_block_status (); // public destructor
81
82 void set_size(int size);
83
84 inline int size() const
85 { return d_size; }
86
87 int work (int noutput_items,
88 gr_vector_const_void_star &input_items,
89 gr_vector_void_star &output_items);
90};
91
92#endif /* INCLUDED_BAZ_BLOCK_STATUS_H */
BAZ_API
#define BAZ_API
Definition api.h:19
baz_make_block_status
BAZ_API baz_block_status_sptr baz_make_block_status(int size, unsigned long work_iterations, unsigned long samples_processed, gr::msg_queue::sptr queue=gr::msg_queue::sptr())
Return a shared_ptr to a new instance of baz_block_status.
baz_block_status
class BAZ_API baz_block_status
Definition baz_block_status.h:34
baz_block_status
square2 a stream of floats.
Definition baz_block_status.h:65
baz_block_status::~baz_block_status
~baz_block_status()
baz_block_status::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
baz_block_status::baz_make_block_status
friend BAZ_API baz_block_status_sptr baz_make_block_status(int size, unsigned long work_iterations, unsigned long samples_processed, gr::msg_queue::sptr queue)
Return a shared_ptr to a new instance of baz_block_status.
baz_block_status::size
int size() const
Definition baz_block_status.h:84
baz_block_status::set_size
void set_size(int size)