file_ror

FILE_ReadOnly_Real Misc ↓ Params ↓ Ports ↓

This components is used to read 32-bit floating point data from a file. The data presented to the input port [In]path specifies the path of the file to open. The path is relative to the User Data directory, "userdata", in the eRT installation directory. If no data is presented to [In]path then the file path is specified using the File name parameter.

It is also possible to specify an absolute path for the file by prefixing "localhost:" to the file path. Users are advised not to use this method as the absolute file path is device dependent.

The data in the file can be structured in a number of ways. The Field Width parameter is used to indicate that the data is of a fixed width format with each data item consisting of n characters where n is the Field Width. A Field Width of "0" indicates that the data is not of a fixed width format. The Delimiter parameter specifies the delimiting character for separating data items in the file. Please note that the delimiter must be enclosed in brackets so that "( )" indicates the use of a single space as a delimiter and "(\n)" denotes the use of a line break as a delimiter. A Delimiter parameter of "()" or "" indicates that no delimiter is used in the file.

The data must be either delimited or of a fixed width format or a combination of the two. A combination of Field Width and Delimiter parameters can be used to indicate that the data is delimited by a special character but to only read in the first n characters of each data item and discard any additional characters where n is the Field Width.

Each data item is read in one item at a time when the input event [In]read is asserted and the data item is presented to the data output [Out]data. The file must be opened before it can be read using the input event [In]open. If there is an error when opening, closing or reading the file then an error code is presented to the data output [Out]err code and the corresponding error event is asserted.

The file is closed when the input event [In]close is asserted and is released by this process. Please note that the input event [In]open closes a previously opened file before opening another. Therefore if multiple files are being read sequentially, it is not necessary to trigger the input event [In]close inbetween the opening, and reading of, each file.

Parameters

Top ↑

Misc ↓

Ports ↓

name	type	default	min.	max.	description
File name	S	out.txt	None	None	The input file path.
Field Width	I	0	0	100	Fixed Width data structure.
Delimiter	S	()	None	None	Character used to delimit data, in the form "(x)" where "x" is the delimiter.

Ports Top ↑ Misc ↓ Params ↑

>Output event, triggered if there is an error reading the file.

In Ev.
open	Input event, opens the file in preparation for reading.
close	Input event, closes the file and releases it.
read	Input event, reads a data item from the file.
Data In
path	Data input, the file path, relative to the User Data directory, of the file to open.
Data Out
data	Data output, the data item read from the file.
err code	Data output, an error code produced if the input events open, close or read fail.
Out Ev.
..	Output event, triggered if the file is opened succesfully.
err	Output event, triggered if there is an error opening the file.
..	Output event, triggered if the file is closed succesfully.
err	Output event, triggered if there is an error closing the file.
..
inc	Asserted if and only if an increment event is received and the count is less than the maximum threshold.

Misc Top ↑ Ports ↑ Params ↑

State Machine
Toolbox	Core	Version	v1.0.
Licence Type	MPL2.0	Component Supplier	inx ltd.
Minumum DCC	A0000	Profiles	All.