Message Debug: Difference between revisions
Jump to navigation
Jump to search
(→Parameters: document new log level param) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
<span id="gr_vad"></span> | |||
<hr> | |||
Debug block for the message passing system. | Debug block for the message passing system. | ||
| Line 5: | Line 8: | ||
== Parameters == | == Parameters == | ||
<b>(''R''):</b> <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span> | <b>(''R''):</b> <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span> | ||
<div data-vad="3.9,3.10"> | |||
<code>Added in 3.9</code> | |||
; PDU Vectors (''R'') | |||
: On or Off - determines if the uniform vector is printed or not. | |||
</div> | |||
<div data-vad="3.8"> | <div data-vad="3.8"> | ||
| Line 10: | Line 19: | ||
; None | ; None | ||
</div> | </div> | ||
<div data-vad="3. | <div data-vad="3.11"> | ||
<code> | <code>Version 3.11, 3.10.6++</code> | ||
; | ; Log level | ||
: | : Sets the "log" input's log level to trace, debug, info, warning, error or critical | ||
</div> | </div> | ||
| Line 20: | Line 29: | ||
=== Inputs === | === Inputs === | ||
<div data-vad="3.9"> | <div data-vad="3.11"> | ||
==== | ==== Versions 3.11 (and >3.10.6.1) ==== | ||
---- | |||
; log | |||
: Logs all messages to the logging system (which by default prints it to your console). '''Generally, this is preferred over the "print" input.''' | |||
; print | |||
: Prints all messages to standard out. If the message is a PDU, it will receive special formatting and the <code>PDU Vectors</code> block parameter will determine if the uniform vector is printed or not. | |||
; store | |||
: Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward. | |||
; print_pdu | |||
: PDU messages are redirected to the <code>print</code> port. This is included for compatibility and is no longer recommended for use. | |||
</div> | |||
<div data-vad="3.9,3.10"> | |||
==== Versions 3.9 and 3.10 ==== | |||
---- | ---- | ||
; print | ; print | ||
| Line 32: | Line 55: | ||
<div data-vad="3.8"> | <div data-vad="3.8"> | ||
==== Version 3.8 ==== | ==== Version 3.8 ==== | ||
---- | ---- | ||
| Line 62: | Line 86: | ||
[[Category:Block Docs]] | [[Category:Block Docs]] | ||
[[Category:Version-adaptive docs]] | |||
Latest revision as of 13:15, 18 May 2023
Debug block for the message passing system.
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.
Parameters
(R): Run-time adjustable
Added in 3.9
- PDU Vectors (R)
- On or Off - determines if the uniform vector is printed or not.
Version 3.8
- None
Version 3.11, 3.10.6++
- Log level
- Sets the "log" input's log level to trace, debug, info, warning, error or critical
Messages
Inputs
Versions 3.11 (and >3.10.6.1)
- log
- Logs all messages to the logging system (which by default prints it to your console). Generally, this is preferred over the "print" input.
- Prints all messages to standard out. If the message is a PDU, it will receive special formatting and the
PDU Vectorsblock parameter will determine if the uniform vector is printed or not. - store
- Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
- print_pdu
- PDU messages are redirected to the
printport. This is included for compatibility and is no longer recommended for use.
Versions 3.9 and 3.10
- Prints all messages to standard out. If the message is a PDU, it will receive special formatting and the
PDU Vectorsblock parameter will determine if the uniform vector is printed or not. - store
- Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
- print_pdu
- PDU messages are redirected to the
printport. This is included for compatibility and is no longer recommended for use.
Version 3.8
- Prints the message to standard out.
- store
- Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
- print_pdu
- Specifically designed to handle formatted PDUs (see pdu.h). It discards messages that aren't PDU pairs (or are null).
Example Flowgraph
In this example, a Message Strobe block sends the string "Demo" once per second. It is displayed on the user terminal by the Message Debug block.
Source Files
- C++ files
- [1]
- Header files
- [2]
- Public header files
- [3]
- Block definition
- [4]