1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
/* -*- c++ -*- */
/* Copyright 2012 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef INCLUDED_PACKET_HEADERGENERATOR_BB_H
#define INCLUDED_PACKET_HEADERGENERATOR_BB_H
#include <digital/api.h>
#include <gr_tagged_stream_block.h>
#include <digital/packet_header_default.h>
namespace gr {
namespace digital {
/*!
* \brief Generates a header for a tagged, streamed packet.
* \ingroup digital
*
* Input: A tagged stream. This is consumed entirely, it is not appended
* to the output stream.
* Output: An tagged stream containing the header. The details on the header
* are set in a header formatter object (of type packet_header_default
* or a subclass thereof). If only a number of bits is specified, a
* default header is generated (see packet_header_default).
*/
class DIGITAL_API packet_headergenerator_bb : virtual public gr_tagged_stream_block
{
public:
typedef boost::shared_ptr<packet_headergenerator_bb> sptr;
/* \param header_formatter A header formatter object.
* \param len_tag_key Length tag key. Note that for header generation,
* it is irrelevant which tag names are set in the
* formatter object, only this value is relevant!
*/
static sptr make(
const packet_header_default::sptr &header_formatter,
const std::string &len_tag_key="packet_len"
);
/* \param header_len If this value is given, a packet_header_default
* object is used to generate the header. This is
* the number of bits per header.
* \param len_tag_key Length tag key.
*/
static sptr make(
long header_len,
const std::string &len_tag_key = "packet_len");
};
} // namespace digital
} // namespace gr
#endif /* INCLUDED_PACKET_HEADERGENERATOR_BB_H */
|
