File Sink: Difference between revisions
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...") |
No edit summary |
||
| Line 1: | Line 1: | ||
[[Category:Block Docs]] | [[Category:Block Docs]] | ||
Used to write a stream to a binary file. This file can be read into any programming environment that can read binary files (MATLAB, C, Python, ...). It can also be played back in GRC using an appropriate [[File Source block]]. For example, if complex type is chosen, then the binary file will be full of float32s in IQIQIQ order. There is no meta data or anything else included with the binary data. | |||
== Parameters == | == Parameters == | ||
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span> | (''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span> | ||
; | ; File (''R'') | ||
: | : Name of the file to open and write output to. | ||
; Unbuffered | |||
: Specifies whether the output is buffered in memory. If the output is unbuffered, the data will be flushed to the file each time the work function is called. This can cause the flowgraph to run slow due to the time required to access the disk each time. | |||
; | ; Append File | ||
: | : Whether or not to append to file, or create a new file each time. | ||
== Example Flowgraph == | == Example Flowgraph == | ||
Revision as of 04:30, 20 July 2019
Used to write a stream to a binary file. This file can be read into any programming environment that can read binary files (MATLAB, C, Python, ...). It can also be played back in GRC using an appropriate File Source block. For example, if complex type is chosen, then the binary file will be full of float32s in IQIQIQ order. There is no meta data or anything else included with the binary data.
Parameters
(R): Run-time adjustable
- File (R)
- Name of the file to open and write output to.
- Unbuffered
- Specifies whether the output is buffered in memory. If the output is unbuffered, the data will be flushed to the file each time the work function is called. This can cause the flowgraph to run slow due to the time required to access the disk each time.
- Append File
- Whether or not to append to file, or create a new file each time.
Example Flowgraph
Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.
Source Files
- C++ files
- TODO
- Header files
- TODO
- Public header files
- TODO
- Block definition
- TODO