Difference between revisions of "Component: CSV Read/Write (Runtime Tools)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 24: | Line 26: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 112: | Line 116: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT |
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 125: | Line 129: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:]] - | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| width="90%" | data | | width="90%" | data | ||
|- | |- | ||
| Line 153: | Line 157: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT |
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 189: | Line 193: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:]] - | + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL |
| width="90%" | Erase | | width="90%" | Erase | ||
|- | |- | ||
| colspan="2" | 0=Append existing data, 1=Reset file data | | colspan="2" | 0=Append existing data, 1=Reset file data | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL |
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
Revision as of 13:29, 17 November 2021
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Runtime Tools |
Contents
CSV Read/Write component
A component to simplify the task of creating and dumping data to a CSV file that can be loaded into Microcoft Excel or LibreOffice Math to create nice charts and graphs.
Detailed description
No detailed description exists yet for this component
Examples
Simple example file to generate a two column CSV file that can be loaded into Microsoft Excel or LibreOffice Math.
Downloadable macro reference
|
CloseFile |
| Closes the file and finishes off any pending writes ready for use in an external application. | |
 - VOID
|
Return |
|
|
SequentialReadString |
| Reads the contents of a cell as a string. Automatically moved to the next data cell after a read. | |
 - STRING
|
Return |
|
|
AddString |
| Adds a string to the CSV followed by a comma. This will form a single column of data in the CSV file. | |
| - STRING
|
data |
| - VOID
|
Return |
|
|
ReadAsString |
| Reads the contents of a cell as a string | |
 - UINT
|
Column |
| - UINT
|
Row |
| - STRING
|
Return |
|
|
SequentialReadNumber |
| Reads the contents of a cell as a number. Automatically moved to the next data cell after a read. | |
 - FLOAT
|
Return |
|
|
AddNumber |
| Adds a number to the CSV followed by a comma. This will form a single column of data in the CSV file. | |
| - FLOAT
|
data |
| - VOID
|
Return |
|
|
ReadAsNumber |
| Reads the contents of a cell as a number. | |
| - UINT
|
Column |
| - UINT
|
Row |
| - FLOAT
|
Return |
|
|
SetSequentialIndex |
| Sets the index for sequential reads. Index is automatically reset to 0 after a file open. | |
| - UINT
|
Index |
| - VOID
|
Return |
|
|
OpenFile |
| Creates or opens a file ready for streaming data. If the file already exists then the contents will be deleted and the file started again from scratch. Returns 1 if file found and opened. | |
| - STRING
|
Filename |
 - BOOL
|
Erase |
| 0=Append existing data, 1=Reset file data | |
| - BOOL
|
Return |
|
|
NextRow |
| Move to the next row in the file | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Filepath |
| Sets the path of the file to write to. $(srcdir) default sets the path to be the same as the Flowcode project path. | |
|
Connections |
|
|
Simulations |
