Options: Difference between revisions
(add Parameters section) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 49: | Line 49: | ||
:default: 'True' | :default: 'True' | ||
:options: [Autostart, 'Off'] | :options: [Autostart, 'Off'] | ||
;Max Number of Output | ;Max Number of Output | ||
:default: '0' | :default: '0' | ||
| Line 85: | Line 84: | ||
; Block definition | ; Block definition | ||
: [https://github.com/gnuradio/gnuradio/blob/main/ | : [https://github.com/gnuradio/gnuradio/blob/main/grc/blocks/options.block.yml options.block.yml] | ||
[[Category:Block Docs]] | [[Category:Block Docs]] | ||
Latest revision as of 18:48, 6 January 2024
The options block sets special parameters for the flow graph. Only one option block is allowed per flow graph.
Title, author, and description parameters are for identification purposes.
The window size controls the dimensions of the flow graph editor. The window size (width, height) must be between (300, 300) and (4096, 4096).
The generate options controls the type of code generated. Non-graphical flow graphs should avoid using graphical sinks or graphical variable controls.
In a graphical application, run can be controlled by a variable to start and stop the flowgraph at runtime.
The id of this block determines the name of the generated file and the name of the class. For example, an id of my_block will generate the file my_block.py and class my_block(gr....
The category parameter determines the placement of the block in the block selection window. The category only applies when creating hier blocks. To put hier blocks into the root category, enter / for the category.
The Max Number of Output is the maximum number of output items allowed for any block in the flowgraph; to disable this set the max_nouts equal to 0.Use this to adjust the maximum latency a flowgraph can exhibit.
Parameters
(R): Run-time adjustable
- Title
- Author
- Copyright
- Description
- Output Language
- default: python
- options: [Python, C++]
- Generate Options
- default: qt_gui
- options: [QT GUI, Bokeh GUI, No GUI, Hier Block, Hier Block (QT GUI)]
- Linking
- default: dynamic
- options: [ Dynamic, Static ]
- Generate CMakeLists.txt
- default: 'On'
- CMake options
- default:
- Category
- default: '[GRC Hier Blocks]'
- Run Options
- default: prompt
- options: [Run to Completion, Prompt for Exit]
- Widget Placement
- default: (0,0)
- Window size
- default: (1000,1000)
- Sizing Mode
- default: fixed
- options: [Fixed, Stretch Both, Scale Width, Scale Height, Scale Both]
- Run
- default: 'True'
- options: [Autostart, 'Off']
- Max Number of Output
- default: '0'
- Realtime Scheduling
- options: ['Off', 'On']
- QSS Theme
- Thread-safe setters
- category: Advanced
- options: ['Off', 'On']
- Catch Block Exceptions
- category: Advanced
- options: ['Off', 'On']
- default: 'True'
- Run Command
- category: Advanced
- default: '{python} -u {filename}'
- Hier Block Source Path
- category: Advanced
- default: '.:'
Example Flowgraph
Example Output
Source Files
- C++ files
- TODO
- Header files
- TODO
- Public header files
- TODO
- Block definition
- options.block.yml