GNU Radio 3.7.3 C++ API
tagged_stream_to_pdu.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2013,2014 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 #ifndef INCLUDED_BLOCKS_TAGGED_STREAM_TO_PDU_H
24 #define INCLUDED_BLOCKS_TAGGED_STREAM_TO_PDU_H
25 
26 #include <gnuradio/blocks/api.h>
27 #include <gnuradio/blocks/pdu.h>
29 
30 namespace gr {
31  namespace blocks {
32 
33  /*!
34  * \brief Turns received stream data and tags into PDUs and sends
35  * them through a message port.
36  * \ingroup message_tools_blk
37  *
38  * The sent message is a PMT-pair (created by pmt::cons()). The
39  * first element is a dictionary containing all the tags. The
40  * second is a vector containing the actual data.
41  */
43  {
44  public:
45  // gr::blocks::tagged_stream_to_pdu::sptr
47 
48  /*!
49  * \brief Construct a tagged_stream_to_pdu block
50  * \param type PDU type of pdu::vector_type
51  * \param lengthtagname The name of the tag that specifies
52  * how long the packet is.
53  */
54  static sptr make(pdu::vector_type type,
55  const std::string& lengthtagname="packet_len");
56  };
57 
58  } /* namespace blocks */
59 } /* namespace gr */
60 
61 #endif /* INCLUDED_BLOCKS_TAGGED_STREAM_TO_PDU_H */
vector_type
Definition: pdu.h:36
Block that operates on PDUs in form of tagged streamsOverride work to provide the signal processing i...
Definition: tagged_stream_block.h:37
boost::shared_ptr< tagged_stream_to_pdu > sptr
Definition: tagged_stream_to_pdu.h:46
Turns received stream data and tags into PDUs and sends them through a message port.The sent message is a PMT-pair (created by pmt::cons()). The first element is a dictionary containing all the tags. The second is a vector containing the actual data.
Definition: tagged_stream_to_pdu.h:42
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30