Raptor:Data Logging File IO: Difference between revisions
No edit summary |
No edit summary |
||
Line 15: | Line 15: | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Close|File Close]]</h5> | ! <h5>[[Raptor:Data Logging File Close|File Close]]</h5> | ||
| <p>This block | | <p>This block closes an open file and flushes all data written to the file system. All files should be closed before the module powers off to ensure data is not lost.</p> | ||
| [[file:RaptorDataLoggingFileClose.png|frameless|border|File Close block|center]] | | [[file:RaptorDataLoggingFileClose.png|frameless|border|File Close block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File EOF|File EOF]]</h5> | ! <h5>[[Raptor:Data Logging File EOF|File EOF]]</h5> | ||
| <p>This block | | <p>This block is used to determine if the current file position is at the end of the file.</p> | ||
| [[file:RaptorDataLoggingFileEOF.png|frameless|border|File EOF block|center]] | | [[file:RaptorDataLoggingFileEOF.png|frameless|border|File EOF block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Exists|File Exists]]</h5> | ! <h5>[[Raptor:Data Logging File Exists|File Exists]]</h5> | ||
| <p>This block | | <p>This block can be used to detect if a file exists on the specified resource.</p> | ||
| [[file:RaptorDisplayFileExists.png|frameless|border|File Exists block|center]] | | [[file:RaptorDisplayFileExists.png|frameless|border|File Exists block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Get Free Space|File Get Free Space]]</h5> | ! <h5>[[Raptor:Data Logging File Get Free Space|File Get Free Space]]</h5> | ||
| <p>This block | | <p>This block returns the free space on the specified resource.</p> | ||
| [[file:RaptorDisplayFileGetFreeSpace.png|frameless|border|File Get Free Space block|center]] | | [[file:RaptorDisplayFileGetFreeSpace.png|frameless|border|File Get Free Space block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Open|File Open]]</h5> | ! <h5>[[Raptor:Data Logging File Open|File Open]]</h5> | ||
| <p>This block | | <p>This block opens a file for read and/or write. It outputs a File Handle which is used with other blocks to read, write and seek within the file.</p> | ||
| [[file:RaptorDataLoggingFileOpen.png|frameless|border|File Open block|center]] | | [[file:RaptorDataLoggingFileOpen.png|frameless|border|File Open block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Position|File Position]]</h5> | ! <h5>[[Raptor:Data Logging File Position|File Position]]</h5> | ||
| <p>This block | | <p>This block is used to get the current file position measured in bytes from start of file.</p> | ||
| [[file:RaptorDataLoggingFilePosition.png|frameless|border|File Position block|center]] | | [[file:RaptorDataLoggingFilePosition.png|frameless|border|File Position block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Read|File Read]]</h5> | ! <h5>[[Raptor:Data Logging File Read|File Read]]</h5> | ||
| <p>This block | | <p>This block is used to read the contents of a file.</p> | ||
| [[file:RaptorDataLoggingFileRead.png|frameless|border|File Read block|center]] | | [[file:RaptorDataLoggingFileRead.png|frameless|border|File Read block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Remove|File Remove]]</h5> | ! <h5>[[Raptor:Data Logging File Remove|File Remove]]</h5> | ||
| <p>This block | | <p>This block removes a file from the specified resource.</p> | ||
| [[file:RaptorDataLoggingFileRemove.png|frameless|border|File Remove block|center]] | | [[file:RaptorDataLoggingFileRemove.png|frameless|border|File Remove block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Rename|File Rename]]</h5> | ! <h5>[[Raptor:Data Logging File Rename|File Rename]]</h5> | ||
| <p>This block | | <p>This block is used to rename a file on a resource. It cannot be used to move a file between resources.</p> | ||
| [[file:RaptorDataLoggingFileRename.png|frameless|border|File Rename block|center]] | | [[file:RaptorDataLoggingFileRename.png|frameless|border|File Rename block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Seek|File Seek]]</h5> | ! <h5>[[Raptor:Data Logging File Seek|File Seek]]</h5> | ||
| <p>This block | | <p>This block is used to move the current position in a file where the next read or write operation will occur.</p> | ||
| [[file:RaptorDataLoggingFileSeek.png|frameless|border|File Seek block|center]] | | [[file:RaptorDataLoggingFileSeek.png|frameless|border|File Seek block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Size|File Size]]</h5> | ! <h5>[[Raptor:Data Logging File Size|File Size]]</h5> | ||
| <p>This block | | <p>This block returns the size of the specified file in bytes.</p> | ||
| [[file:RaptorDataLoggingFileSize.png|frameless|border|File Size block|center]] | | [[file:RaptorDataLoggingFileSize.png|frameless|border|File Size block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Sync|File Sync]]</h5> | ! <h5>[[Raptor:Data Logging File Sync|File Sync]]</h5> | ||
| <p>This block | | <p>This block flushes all pending data writes to the flash file system.</p> | ||
| [[file:RaptorDisplayFileSync.png|frameless|border|File Sync block|center]] | | [[file:RaptorDisplayFileSync.png|frameless|border|File Sync block|center]] | ||
|- | |- | ||
! <h5>[[Raptor:Data Logging File Write|File Write]]</h5> | ! <h5>[[Raptor:Data Logging File Write|File Write]]</h5> | ||
| <p>This block | | <p>This block is used to write data to a file. The block accepts uint8[] or string data types.</p> | ||
| [[file:RaptorDisplayFileWrite.png|frameless|border|File Write block|center]] | | [[file:RaptorDisplayFileWrite.png|frameless|border|File Write block|center]] | ||
|} | |} |
Revision as of 17:47, 7 July 2014
Return to the main Raptor page
Return to Data Logging Libraries page

The blocks in this subsystem...
Blocks
Block | Description | Appearance |
---|---|---|
File Close |
This block closes an open file and flushes all data written to the file system. All files should be closed before the module powers off to ensure data is not lost. |
![]() |
File EOF |
This block is used to determine if the current file position is at the end of the file. |
![]() |
File Exists |
This block can be used to detect if a file exists on the specified resource. |
|
File Get Free Space |
This block returns the free space on the specified resource. |
|
File Open |
This block opens a file for read and/or write. It outputs a File Handle which is used with other blocks to read, write and seek within the file. |
![]() |
File Position |
This block is used to get the current file position measured in bytes from start of file. |
![]() |
File Read |
This block is used to read the contents of a file. |
![]() |
File Remove |
This block removes a file from the specified resource. |
![]() |
File Rename |
This block is used to rename a file on a resource. It cannot be used to move a file between resources. |
![]() |
File Seek |
This block is used to move the current position in a file where the next read or write operation will occur. |
![]() |
File Size |
This block returns the size of the specified file in bytes. |
![]() |
File Sync |
This block flushes all pending data writes to the flash file system. |
|
File Write |
This block is used to write data to a file. The block accepts uint8[] or string data types. |