GNU Radio's FOO Package: pad_tagged_stream.h Source File

GNU Radio's FOO Package

pad_tagged_stream.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2019 "Cyancali".
4 *
5 * This is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3, or (at your option)
8 * any later version.
9 *
10 * This software is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this software; see the file COPYING. If not, write to
17 * the Free Software Foundation, Inc., 51 Franklin Street,
18 * Boston, MA 02110-1301, USA.
19 */
20
21#ifndef INCLUDED_FOO_PAD_TAGGED_STREAM_H
22#define INCLUDED_FOO_PAD_TAGGED_STREAM_H
23
24#include <foo/api.h>
25#include <gnuradio/tagged_stream_block.h>
26
27namespace gr {
28 namespace foo {
29
30 /*!
31 * \brief <+description of block+>
32 * \ingroup foo
33 *
34 */
35 class FOO_API pad_tagged_stream : virtual public gr::tagged_stream_block
36 {
37 public:
38 typedef std::shared_ptr<pad_tagged_stream> sptr;
39
40 /*!
41 * \brief Return a shared_ptr to a new instance of foo::pad_tagged_stream.
42 *
43 * To avoid accidental use of raw pointers, foo::pad_tagged_stream's
44 * constructor is in a private implementation
45 * class. foo::pad_tagged_stream::make is the public interface for
46 * creating new instances.
47 */
48 static sptr make(int buffer_size, const std::string len_tag_name);
49 };
50
51 } // namespace foo
52} // namespace gr
53
54#endif /* INCLUDED_FOO_PAD_TAGGED_STREAM_H */
55
api.h
FOO_API
#define FOO_API
Definition api.h:19
gr::foo::pad_tagged_stream
<+description of block+>
Definition pad_tagged_stream.h:36
gr::foo::pad_tagged_stream::sptr
std::shared_ptr< pad_tagged_stream > sptr
Definition pad_tagged_stream.h:38
gr::foo::pad_tagged_stream::make
static sptr make(int buffer_size, const std::string len_tag_name)
Return a shared_ptr to a new instance of foo::pad_tagged_stream.
gr::foo
Definition burst_tagger.h:28
gr
Definition burst_tagger.h:27