gr-baz Package

baz_tag_to_msg.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004 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_TAG_TO_MSG_H
29#define INCLUDED_BAZ_TAG_TO_MSG_H
30
31#include <gnuradio/sync_block.h>
32#include <gnuradio/msg_queue.h>
33#include <string>
34
35 class baz_tag_to_msg;
36
37/*
38 * We use boost::shared_ptr's instead of raw pointers for all access
39 * to gr::blocks (and many other data structures). The shared_ptr gets
40 * us transparent reference counting, which greatly simplifies storage
41 * management issues. This is especially helpful in our hybrid
42 * C++ / Python system.
43 *
44 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
45 *
46 * As a convention, the _sptr suffix indicates a boost::shared_ptr
47 */
48 typedef boost::shared_ptr<baz_tag_to_msg> baz_tag_to_msg_sptr;
49
50/*!
51 * \brief Return a shared_ptr to a new instance of baz_tag_to_msg.
52 *
53 * To avoid accidental use of raw pointers, baz_tag_to_msg's
54 * constructor is private. baz_make_tag_to_msg is the public
55 * interface for creating new instances.
56 */
57baz_tag_to_msg_sptr baz_make_tag_to_msg (int item_size, gr::msg_queue::sptr msgq, const char* append = NULL/*, int initial_buffer_size = -1*/);
58
59/*!
60 * \brief square2 a stream of floats.
61 * \ingroup block
62 *
63 * This uses the preferred technique: subclassing gr::sync_block.
64 */
65 class baz_tag_to_msg : public gr::sync_block
66{
67 private:
68 // The friend declaration allows baz_make_tag_to_msg to access the private constructor.
69
70 friend baz_tag_to_msg_sptr baz_make_tag_to_msg (int item_size, gr::msg_queue::sptr msgq, const char* append/*, int initial_buffer_size*/);
71
72 baz_tag_to_msg (int item_size, gr::msg_queue::sptr msgq, const char* append/*, int initial_buffer_size*/); // private constructor
73
74 int d_item_size;
75 gr::msg_queue::sptr d_msgq;
76 //char* d_buffer;
77 //int d_buffer_size;
78 std::string d_appended;
79
80 public:
81 ~baz_tag_to_msg (); // public destructor
82
83 void set_msgq(gr::msg_queue::sptr msgq);
84 void set_appended_string(const char* append);
85
86 int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items);
87};
88
89#endif /* INCLUDED_BAZ_TAG_TO_MSG_H */
baz_make_tag_to_msg
baz_tag_to_msg_sptr baz_make_tag_to_msg(int item_size, gr::msg_queue::sptr msgq, const char *append=NULL)
Return a shared_ptr to a new instance of baz_tag_to_msg.
baz_tag_to_msg
square2 a stream of floats.
Definition: baz_tag_to_msg.h:66
baz_tag_to_msg::set_appended_string
void set_appended_string(const char *append)
baz_tag_to_msg::set_msgq
void set_msgq(gr::msg_queue::sptr msgq)
baz_tag_to_msg::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
baz_tag_to_msg::baz_make_tag_to_msg
friend baz_tag_to_msg_sptr baz_make_tag_to_msg(int item_size, gr::msg_queue::sptr msgq, const char *append)
Return a shared_ptr to a new instance of baz_tag_to_msg.
baz_tag_to_msg::~baz_tag_to_msg
~baz_tag_to_msg()