Go to the source code of this file.
Classes | |
struct | SQ_ModelOptions |
struct | tagSQ_ModelInfo |
This file includes all enum objects used in different functions and common functions about logging, license file etc.
typedef enum SQ_TriStateBacktransformedState SQ_BacktransformedState |
An enum defining the a tristate for Backtransformed.
typedef enum SQ_BoolEnum SQ_Bool |
An enum defining true or false.
typedef enum SQ_CoefficientsRotatedTypeEnum SQ_CoefficientsRotatedType |
Different types of coefficients that is used in the GetModelCoefficientsRotated function.
typedef void( * SQ_LogFunction) (const char *szMessage, int iStatus) |
[out] | szMessage | The log message, UTF-8 encoded. |
[out] | iStatus | 1 if the message is an error message, 0 if the message is an informative message. |
typedef struct tagSQ_ModelInfo SQ_ModelInfo |
A struct with information about a model
An enum defining the a tristate for Modeling power weighted.
typedef enum SQ_ModelTypeEnum SQ_ModelType |
An enum defining the different model types.
typedef enum SQ_TriStateNormalizedState SQ_NormalizedState |
An enum defining the a tristate for Normalized.
typedef void( * SQ_PredictionLogFunction) (int iNumberOfPredictions, int iNumberOfProjectsOpened) |
[out] | iNumberOfPredictions | Number of predictions made since last time the callback function was called. |
[out] | iStatus | Number of projects that has been opened since last time the callback function was called. |
typedef enum SQ_ProductEnum SQ_Product |
An enum defining the different product types.
typedef enum SQ_TriStateReconstructState SQ_ReconstructState |
An enum defining the a tristate for Reconstruct.
An enum defining the a tristate for ResolveHierachical.
typedef enum SQ_TriStateStandardizedState SQ_StandardizedState |
An enum defining the a tristate for Standardized.
typedef enum SQ_TriStateUnscaledState SQ_UnscaledState |
An enum defining the a tristate for Unscaled.
typedef enum SQ_BlockTypeEnum SQ_VariableBlock |
Indicates which variable block a variable belongs to.
typedef enum SQ_VariableTypeType SQ_VariableType |
Enum values describing what kind of type a variable is of
typedef enum SQ_WeightTypeEnum SQ_WeightType |
An enum defining the different weights that are expected as input to the Contribution functions.
enum SQ_BlockTypeEnum |
enum SQ_BoolEnum |
An enum defining true or false.
Different types of coefficients that is used in the GetModelCoefficientsRotated function.
enum SQ_ModelTypeEnum |
An enum defining the different model types.
enum SQ_ProductEnum |
An enum defining the a tristate for Backtransformed.
An enum defining the a tristate for Modeling power weighted.
An enum defining the a tristate for Normalized.
An enum defining the a tristate for Reconstruct.
An enum defining the a tristate for ResolveHierachical.
An enum defining the a tristate for Standardized.
An enum defining the a tristate for Unscaled.
enum SQ_VariableTypeType |
enum SQ_WeightTypeEnum |
An enum defining the different weights that are expected as input to the Contribution functions.
SQ_ErrorCode SQ_GetLicenseFileExpireDate | ( | char * | szExpireDate, |
int | iLength | ||
) |
Checks if a license file is present and valid and in that case for how long the license is valid.
[in,out] | szExpireDate | A buffer to where the expire date should be stored. The string will be empty if no expire date is set or if the license file is not valid. The user is responsible for allocation/deallocation. |
[in] | iLength | The size of the buffer. |
SQ_ErrorCode SQ_GetLicenseFileProduct | ( | SQ_Product * | pSQProduct | ) |
Get the product of the license file.
[out] | pSQProduct | The product of the license file. |
SQ_ErrorCode SQ_GetLogFile | ( | char * | szPathName, |
int | iBufferLength | ||
) |
Returns the path of the log file, "" if there does not exist a log file (the log has been turned of or the log function is used).
[in,out] | szPathName | The path to and name of the logfile, UTF-8 encoded. The user is responsible to allocate and deallocate the buffer. |
[in] | iBufferLength | The length of the buffer. |
SQ_ErrorCode SQ_GetLoggingStatus | ( | SQ_Bool * | pbStatus | ) |
Returns a status indicating if SIMCA-Q is logging information and errors or not.
[out] | pbStatus | SQ_True if the log is on, SQ_False otherwise |
SQ_ErrorCode SQ_GetMissingValue | ( | float * | pfVal | ) |
Retrieves the number that represents missing value.
[out] | pfVal | The number that represents missing value in SIMCA-Q. |
SQ_ErrorCode SQ_GetPredictionLogFile | ( | char * | szPathName, |
int | iBufferLength | ||
) |
Returns the path of the prediction log file, "" if there does not exist a log file (the license doesn't enable logging or the log function is used).
[in,out] | szPathName | The path to and name of the logfile, UTF-8 encoded. The user is responsible to allocate and deallocate the buffer. |
[in] | iBufferLength | The length of the buffer. |
SQ_ErrorCode SQ_GetVersionNumber | ( | int * | iMajorVersion, |
int * | iMinorVersion, | ||
int * | iBuildNumber, | ||
int * | iRevisionNumber | ||
) |
Retrieves the version number of the SIMCA-Q.dll. Four numbers will be returned that can be combined in the following format 13.0.0.0.
[out] | iMajorVersion | The major version. |
[out] | iMinorVersion | The minor version. |
[out] | iBuildNumber | The build number. |
[out] | iRevisionNumber | The revision number. |
SQ_ErrorCode SQ_IsLicenseFileValid | ( | SQ_Bool * | bValid | ) |
Checks if a license file is present and in that case valid.
[out] | bValid | SQ_True if the file has been found and is valid, SQ_False if not, in that case see the log file for details. |
SQ_ErrorCode SQ_IsProjectValid | ( | const char * | szProjectName, |
const char * | szPassword, | ||
SQ_Bool * | bValid | ||
) |
Checks if a project is valid and can be opened by this version of SIMCA-Q. Don't use this function on a opened project.
[in] | szProjectName | The full path to the project file, UTF-8 encoded. |
[in] | szPassword | The password if the project is password protected, UTF-8 encoded, if not use NULL. |
[out] | bValid | SQ_True if the file is a valid project, SQ_False if not, in that case see the log file for details. |
SQ_ErrorCode SQ_SetLicensePath | ( | const char * | szLicensePath | ) |
Set the directory of where the license file is located. If this function is not called SIMCA-Q will look for the license file in the working directory.
[in] | szLicensePath | Path to where the license file is located, UTF-8 encoded. |
SQ_ErrorCode SQ_SetLogFile | ( | const char * | szPathName | ) |
User defined log file. This function can only be called before any other initialization. Make sure that the directory exists before calling this function.
[in] | szPathName | The path to and name of the logfile, UTF-8 encoded. |
SQ_ErrorCode SQ_SetLogFunction | ( | SQ_LogFunction | pFunction | ) |
User defined log function.
[in] | pFunction | The function the user wants to use for logging. |
SQ_ErrorCode SQ_SetLoggingStatus | ( | SQ_Bool | bLogOn | ) |
Sets the status indicating if SIMCA-Q should log information and errors or not.
[in] | bLogOn | SQ_True if the log should be turned on, SQ_False otherwise |
SQ_ErrorCode SQ_SetOEMPassword | ( | const char * | szOEMPassword | ) |
If the SIMCA-Q is part of an OEM solution, the password for the license file should be applied with this function. The password is case sensitive.
[in] | szOEMPassword | The OEM password that is valid for the license file, UTF-8 encoded. |
SQ_ErrorCode SQ_SetPluginPath | ( | const char * | szPluginPath | ) |
Set the directory of where the plug-ins for spectral filters are located. If this function is not called SIMCA-Q will look for the plug-ins in the working directory.
[in] | szPluginPath | Path to where the plug-ins are located, UTF-8 encoded. |
SQ_ErrorCode SQ_SetPredictionLogFile | ( | const char * | szPathName | ) |
Prediction logging User defined prediction log file. This function can only be called before opening a project. Make sure that the directory exists before calling this function.
[in] | szPathName | The path to and name of the prediction logging, UTF-8 encoded. |
SQ_ErrorCode SQ_SetPredictionLogFunction | ( | SQ_PredictionLogFunction | pFunction | ) |
User defined prediction log function.
[in] | pFunction | The function the user wants to use for logging. |
SQ_ErrorCode SQ_UseMultiThreading | ( | SQ_Bool | bMultiThread, |
int | iNumProcessors | ||
) |
Turn multi-threading on or off. Multi-threading makes SIMCA-Q faster for larger projects if run on more than one processor. Multi-threading should be turned off for small projects were many predictions are performed and for hyper-threaded (old Pentium) processors.
[in] | bMultiThread | SQ_True to use multi-threading, SQ_False if no multi-threading should be used. |
[in] | iNumProcessors | The number of processors decides the maximum number of simultaneous threads SIMCA-Q will execute. A higher value than the actual number of processors will make SIMCA-Q slower. -1 means default number of processors. This parameter is ignored if bMultiThread is set to SQ_False. |
Copyright (C) Sartorius Stedim Data Analytics AB - Generated by Doxygen