Component: Input CSV (DSP Inputs)

Author	Matrix Ltd
Version	1.2
Category	DSP Inputs

Input CSV component

Allows the values from a buffer to be collected directly from a CSV file. Either a value at a time or from an array.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_DSP_FileInput.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_DSP_FileInput.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

	CloseFile
Closes a file
- VOID	Return

	OpenFile
Opens a file ready for reading. Returns 1 if file opened correctly. Automatically called by the ReadValue/ReadArray macros with the default values set by the component properties if not already called by the program.
- STRING	Filename
- BOOL	Return

	ReadArray
Reads an array of values to fill up the specified buffer. FAT component must be initialised before calling this macro. Returns 0 when we are at the end of the file, else returns 1.
- BOOL	Return

	ReadValue
Reads a value from the current row in the CSV file. FAT component must be initialised before calling this macro. Returns 0 when we are at the end of the file, else returns 1.
- BOOL	Return

Property reference

	Properties
	Buffer Size 0
	Buffer Type 0
	CSV File
	LinkTo
	Filename
Name of the file to read DSP data from.
	Number of Outputs
The number of outputs the CSV reader can provide. Each output will be driven by the corresponding column of the CSV file.
	End of File
Determines what happens when we hit the end of the input file. The return value from the ReadValue/ReadArray can be checked to allow the file end to be caught and actioned.

==Macro reference==

	CloseFile
Closes a file
- VOID	Return

	OpenFile
Opens a file ready for reading. Returns 1 if file opened correctly. Automatically called by the ReadValue/ReadArray macros with the default values set by the component properties if not already called by the program.
- STRING	Filename
- BOOL	Return

	ReadArray
Reads an array of values to fill up the specified buffer. FAT component must be initialised before calling this macro. Returns 0 when we are at the end of the file, else returns 1.
- BOOL	Return

	ReadValue
Reads a value from the current row in the CSV file. FAT component must be initialised before calling this macro. Returns 0 when we are at the end of the file, else returns 1.
- BOOL	Return

Property reference

	Properties
	Buffer Size 0
	Buffer Type 0
	CSV File
	LinkTo
	Filename
Name of the file to read DSP data from.
	Number of Outputs
The number of outputs the CSV reader can provide. Each output will be driven by the corresponding column of the CSV file.
	End of File
Determines what happens when we hit the end of the input file. The return value from the ReadValue/ReadArray can be checked to allow the file end to be caught and actioned.

==Macro reference==

	CloseFile
Closes a file
- VOID	Return

	OpenFile
Opens a file ready for reading. Returns 1 if file opened correctly. Automatically called by the ReadValue/ReadArray macros with the default values set by the component properties if not already called by the program.
- STRING	Filename
- BOOL	Return

	ReadArray
Reads an array of values to fill up the specified buffer. FAT component must be initialised before calling this macro. Returns 0 when we are at the end of the file, else returns 1.
- BOOL	Return

	ReadValue
Reads a value from the current row in the CSV file. FAT component must be initialised before calling this macro. Returns 0 when we are at the end of the file, else returns 1.
- BOOL	Return

Property reference

	Properties
	Buffer Size 0
	Buffer Type 0
	CSV File
	LinkTo
	Filename
Name of the file to read DSP data from.
	Number of Outputs
The number of outputs the CSV reader can provide. Each output will be driven by the corresponding column of the CSV file.
	End of File
Determines what happens when we hit the end of the input file. The return value from the ReadValue/ReadArray can be checked to allow the file end to be caught and actioned.

==Macro reference==

	CloseFile
Closes a file
- VOID	Return

	OpenFile
Opens a file ready for reading. Returns 1 if file opened correctly. Automatically called by the ReadValue/ReadArray macros with the default values set by the component properties if not already called by the program.
- STRING	Filename
- BOOL	Return

	ReadArray
Reads an array of values to fill up the specified buffer. FAT component must be initialised before calling this macro. Returns 0 when we are at the end of the file, else returns 1.
- BOOL	Return

	ReadValue
Reads a value from the current row in the CSV file. FAT component must be initialised before calling this macro. Returns 0 when we are at the end of the file, else returns 1.
- BOOL	Return

Property reference

	Properties
	Buffer Size 0
	Buffer Type 0
	CSV File
	LinkTo
	Filename
Name of the file to read DSP data from.
	Number of Outputs
The number of outputs the CSV reader can provide. Each output will be driven by the corresponding column of the CSV file.
	End of File
Determines what happens when we hit the end of the input file. The return value from the ReadValue/ReadArray can be checked to allow the file end to be caught and actioned.