Classes | Typedefs | Functions
SIMCA-Q File Reader

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_FileReaderHandleSQ_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)
 

Detailed Description

Typedef Documentation

◆ 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!

◆ SQ_FileReader_Options

The options on how to open the file.

◆ SQ_FileReader_Specification

The specification of where to find the information in the file.

Function Documentation

◆ SQ_CloseFileReader()

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.

Parameters
[in]pFileHandleThe handle to be released.
Returns
Returns SQ_E_OK if success or an error code.

◆ SQ_FileReader_PredictFromFile()

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.

Parameters
[in]pModelThe model handle to use.
[in]pFileHandleThe handle of the file where the predictionset is stored.
[in]pSpecificationThe specification of the file,
See also
SQ_FileReader_Specification.
Parameters
[out]pPredHandleThe prediction handle that should be used to retrieve the prediction results.
Must be released by SQ_ClearPrediction.
Returns
Returns SQ_E_OK if success or an error code.

◆ SQ_OpenFileReader()

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.

Parameters
[in]pInputFilesThe file/s that contains the data, only file formats that support multiple files can be used with more than one file name.
[in]szPluginPathIf 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]pOptionsOptions for the different file types,
See also
SQ_FileReader_Options.
Parameters
[out]pFileHandleThe handle of the FileReader.
Returns
Returns SQ_E_OK if success or an error code.

Copyright (C) Sartorius Stedim Data Analytics AB - Generated by Doxygen