Classes | |
struct | tagSQ_FileReaderHandle |
This is the content of the SIMCA-Q File Reader. More... | |
struct | tagSQ_FileReader_Specification |
struct | tagSQ_FileReader_Options |
Typedefs | |
typedef struct tagSQ_FileReaderHandle * | SQ_FileReader |
This is the content of the SIMCA-Q File Reader. More... | |
typedef struct tagSQ_FileReader_Specification | SQ_FileReader_Specification |
typedef struct tagSQ_FileReader_Options | SQ_FileReader_Options |
Functions | |
SQ_ErrorCode | SQ_OpenFileReader (SQ_StringVector pInputFiles, const char *szPluginPath, SQ_FileReader_Options *pOptions, SQ_FileReader *pFileHandle) |
SQ_ErrorCode | SQ_CloseFileReader (SQ_FileReader *pFileHandle) |
SQ_ErrorCode | SQ_FileReader_PredictFromFile (SQ_Model pModel, SQ_FileReader pFileHandle, SQ_FileReader_Specification *pSpecification, SQ_Prediction *pPredHandle) |
typedef struct tagSQ_FileReaderHandle * SQ_FileReader |
This is the content of the SIMCA-Q File Reader.
The handle used to identify a FileReader object. IMPORTANT: Always initialize it to NULL!
typedef struct tagSQ_FileReader_Options SQ_FileReader_Options |
The options on how to open the file.
typedef struct tagSQ_FileReader_Specification SQ_FileReader_Specification |
The specification of where to find the information in the file.
SQ_ErrorCode SQ_CloseFileReader | ( | SQ_FileReader * | pFileHandle | ) |
Releases the FileReader handle returned by SQ_OpenFileReader(), this function must be called for every handle that is created.
[in] | pFileHandle | The handle to be released. |
SQ_ErrorCode SQ_FileReader_PredictFromFile | ( | SQ_Model | pModel, |
SQ_FileReader | pFileHandle, | ||
SQ_FileReader_Specification * | pSpecification, | ||
SQ_Prediction * | pPredHandle | ||
) |
Predicts the imported file with the given options, a handle is returned that should be used to get the results. ReleaseHandle should be called to remove the handle.
[in] | pModel | The model handle to use. |
[in] | pFileHandle | The handle of the file where the predictionset is stored. |
[in] | pSpecification | The specification of the file, |
[out] | pPredHandle | The prediction handle that should be used to retrieve the prediction results. Must be released by SQ_ClearPrediction. |
SQ_ErrorCode SQ_OpenFileReader | ( | SQ_StringVector | pInputFiles, |
const char * | szPluginPath, | ||
SQ_FileReader_Options * | pOptions, | ||
SQ_FileReader * | pFileHandle | ||
) |
Loads and reads one or more files containing data that should be used to perform a prediction on, a handle is returned that should be used to get the results. SQ_FileReader_ReleaseFileHandle should be called to remove the handle.
[in] | pInputFiles | The file/s that contains the data, only file formats that support multiple files can be used with more than one file name. |
[in] | szPluginPath | If the file is of a format that is implemented as a plug-in, this should be the path to the plug-in, UTF-8 encoded. |
[in] | pOptions | Options for the different file types, |
[out] | pFileHandle | The handle of the FileReader. |
Copyright (C) Sartorius Stedim Data Analytics AB - Generated by Doxygen