Message Debug: Difference between revisions
Jump to navigation
Jump to search
(add section for version 3.9; revised format) |
(add parameter; reorganize) |
||
| Line 5: | Line 5: | ||
== Parameters == | == Parameters == | ||
<b>(''R''):</b> <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span> | |||
; | <code>Added in 3.9</code> | ||
; PDU Vectors (''R'') | |||
: On or Off - determines if the uniform vector is printed or not. | |||
== Messages == | == Messages == | ||
=== Inputs === | === Inputs === | ||
<div data-vad="3. | <div data-vad="3.9"> | ||
==== | ==== Version 3.9 ==== | ||
---- | ---- | ||
; print | ; print | ||
: Prints | : 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 | ; 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. | : 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 | ; 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> | ||
<div data-vad="3. | <div data-vad="3.8"> | ||
==== | ==== Version 3.8 ==== | ||
---- | ---- | ||
; print | ; print | ||
: Prints | : Prints the message to standard out. | ||
; store | ; 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. | : 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 | ; print_pdu | ||
: PDU | : Specifically designed to handle formatted PDUs (see pdu.h). It discards messages that aren't PDU pairs (or are null). | ||
</div> | </div> | ||
Revision as of 20:27, 5 December 2022
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.
Messages
Inputs
Version 3.9
- 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]