Message Debug: Difference between revisions

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.
print: Prints all messages to standard out. If the message is a PDU, it will receive special formatting and the PDU Vectors 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 print port. This is included for compatibility and is no longer recommended for use.

Versions 3.9 and 3.10

print: Prints all messages to standard out. If the message is a PDU, it will receive special formatting and the PDU Vectors 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 print port. This is included for compatibility and is no longer recommended for use.

Version 3.8

print: 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]

@@ Line 1: / Line 1: @@
-[[Category:Block Docs]]
+__NOTOC__
+<span id="gr_vad"></span>
+<hr>
 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.
-The message ports are:
+== Parameters ==
+<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">
+<code>Version 3.8</code>
+; None
+</div>
-* print: prints the message directly to standard out.
+<div data-vad="3.11">
-* store: stores the message in an internal vector. May be access using the get_message function.
+<code>Version 3.11, 3.10.6++</code>
-* print_pdu: specifically designed to handle formatted PDUs (see pdu.h).
+; Log level
+: Sets the "log" input's log level to trace, debug, info, warning, error or critical
+</div>
-== Parameters ==
+== Messages ==
+=== Inputs ===
+<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
+: 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.8">
-None
+==== Version 3.8 ====
+----
+; print
+: 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).
+</div>
 == 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.
 [[File:PUB_SUB_msg_demo.png]]
@@ Line 21: / Line 74: @@
 ; C++ files
-: [https://github.com/gnuradio/gnuradio TODO]
+: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/message_debug_impl.cc]
 ; Header files
-: [https://github.com/gnuradio/gnuradio TODO]
+: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/message_debug_impl.h]
 ; Public header files
-: [https://github.com/gnuradio/gnuradio TODO]
+: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/include/gnuradio/blocks/message_debug.h]
 ; Block definition
-: [https://github.com/gnuradio/gnuradio TODO]
+: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_message_debug.block.yml]
+[[Category:Block Docs]]
+[[Category:Version-adaptive docs]]