blob: d2cfc59f240cf7c9468ed8ab694ad835efe504a4 (
plain)
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
73
74
75
76
77
78
79
80
81
|
/* -*- c++ -*- */
/*
* Copyright 2005,2012-2013 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_GR_MESSAGE_DEBUG_H
#define INCLUDED_GR_MESSAGE_DEBUG_H
#include <gnuradio/block.h>
#include <gnuradio/blocks/api.h>
namespace gr {
namespace blocks {
/*!
* \brief Debug block for the message passing system.
* \ingroup message_tools_blk
* \ingroup measurement_tools_blk
* \ingroup debug_tools_blk
*
* \details
* The message debug block is used to capture and print or store
* messages as they are received. Any block that generates a
* message may connect that message port to one or more of the
* three message input ports of this debug block. The message
* ports are:
*
* \li print: prints the message directly to standard out.
* \li store: stores the message in an internal vector. May be
* access using the get_message function.
* \li print_pdu: specifically designed to handle formatted PDUs
* (see pdu.h).
*/
class BLOCKS_API message_debug : virtual public block
{
public:
// gr::blocks::message_debug::sptr
typedef std::shared_ptr<message_debug> sptr;
/*!
* \brief Build the message debug block. It takes no parameters
* and has three message ports: print, store, and
* print_pdu.
*/
static sptr make(bool en_uvec = true);
/*!
* \brief Reports the number of messages received by this block.
*/
virtual int num_messages() = 0;
/*!
* \brief Get a message (as a PMT) from the message vector at index \p i.
*
* Messages passed to the 'store' port will be stored in a
* vector. This function retrieves those messages by index. They
* are index in order of when they were received (all messages
* are just pushed onto the back of a vector). This is mostly
* useful in debugging message passing graphs and in QA code.
*
* \param i The index in the vector for the message to retrieve.
*
* \return a message at index \p i as a pmt_t.
*/
virtual pmt::pmt_t get_message(int i) = 0;
/*!
* \brief Enables or disables printing of PDU uniform vector data.
*/
virtual void set_vector_print(bool en) = 0;
};
} /* namespace blocks */
} /* namespace gr */
#endif /* INCLUDED_GR_MESSAGE_DEBUG_H */
|
