#include "SQDef.h"
#include "SQErrorCodes.h"
#include "SQCommon.h"
#include "SQIntVector.h"
#include "SQStringVector.h"
Go to the source code of this file.
Classes | |
struct | tagSQ_VariableVector |
struct | tagSQ_Variable |
Typedefs | |
typedef struct tagSQ_VariableVector * | SQ_VariableVector |
typedef struct tagSQ_Variable * | SQ_Variable |
Functions | |
SQ_ErrorCode | SQ_GetNumVariablesInVector (SQ_VariableVector pVariables, int *iSize) |
SQ_ErrorCode | SQ_GetVariableFromVector (SQ_VariableVector pVariables, int iIndex, SQ_Variable *pVariable) |
SQ_ErrorCode | SQ_GetVariableName (SQ_Variable pVariable, int iNameID, char *szVariableName, int iBufferLength) |
SQ_ErrorCode | SQ_GetVariableIDs (SQ_Variable pVariable, SQ_IntVector *pVariableIDs) |
SQ_ErrorCode | SQ_IsQualitative (SQ_Variable pVariable, SQ_Bool *bIsQualitative) |
SQ_ErrorCode | SQ_GetQualitativeSettings (SQ_Variable pVariable, SQ_StringVector *pSettings) |
SQ_ErrorCode | SQ_IsLagged (SQ_Variable pVariable, SQ_Bool *bIsLagged) |
SQ_ErrorCode | SQ_HasDynamicLags (SQ_Variable pVariable, SQ_Bool *bHasDynamicLags) |
SQ_ErrorCode | SQ_GetLagSteps (SQ_Variable pVariable, SQ_IntVector *pLagSteps) |
SQ_ErrorCode | SQ_IsXVariable (SQ_Variable pVariable, SQ_Bool *bIsXVariable) |
SQ_ErrorCode | SQ_IsPhaseIterationVariable (SQ_Variable pVariable, SQ_Bool *bIsPhaseIterVariable) |
This file list the SQVariable object used in Umetrics SIMCA-Q products.
typedef struct tagSQ_Variable * SQ_Variable |
The object used to identify a variable.
typedef struct tagSQ_VariableVector * SQ_VariableVector |
The object used to identify a vector of variables. IMPORTANT: Always initialize it to NULL!
SQ_ErrorCode SQ_GetLagSteps | ( | SQ_Variable | pVariable, |
SQ_IntVector * | pLagSteps | ||
) |
Gets the lag steps for the variable.
[in] | pVariable | The variable to get the name of. |
[out] | pLagSteps | The lag steps for the variable. The vector must be cleared with SQ_ClearIntVector. |
SQ_ErrorCode SQ_GetNumVariablesInVector | ( | SQ_VariableVector | pVariables, |
int * | iSize | ||
) |
Returns the number of variables in the Vector.
[in] | pVariables | The VariableVector to get the number of variables from. |
[out] | iSize | The number of variables in the Vector. |
SQ_ErrorCode SQ_GetQualitativeSettings | ( | SQ_Variable | pVariable, |
SQ_StringVector * | pSettings | ||
) |
Gets the settings for the qualitative variable.
[in] | pVariable | The variable to get the name of. |
[out] | pSettings | The settings, empty if the variable is not qualitative. The vector must be cleared with SQ_ClearStringVector. |
SQ_ErrorCode SQ_GetVariableFromVector | ( | SQ_VariableVector | pVariables, |
int | iIndex, | ||
SQ_Variable * | pVariable | ||
) |
Gets the variable from a given position in the Vector.
[in] | pVariables | The VariableVector to get the variable from. |
[in] | iIndex | The index in the Vector to get the variable from. |
[out] | pVariable | The variable requested. |
SQ_ErrorCode SQ_GetVariableIDs | ( | SQ_Variable | pVariable, |
SQ_IntVector * | pVariableIDs | ||
) |
Gets the variable IDs used in the current model/dataset.
[in] | pVariable | The variable to use. |
[out] | pVariableIDs | The variable IDs used. |
SQ_ErrorCode SQ_GetVariableName | ( | SQ_Variable | pVariable, |
int | iNameID, | ||
char * | szVariableName, | ||
int | iBufferLength | ||
) |
Gets the name of a variable
[in] | pVariable | The variable to get the name of. |
[in] | iNameID | The ID of the name to get. |
[in,out] | szVariableName | A buffer to where the name should be stored, UTF-8 encoded. The user is responsible for allocation/deallocation. |
[in] | iBufferLength | The size of the buffer. |
SQ_ErrorCode SQ_HasDynamicLags | ( | SQ_Variable | pVariable, |
SQ_Bool * | bHasDynamicLags | ||
) |
Gets information whether the variable has dynamic lags or not, if so predictions might quire more lagged data if the process is faster then when modeled. Only valid if the variable is from a model
[in] | pVariable | The variable to get the name of. |
[out] | bHasDynamicLags | SQ_True if the variable is lagged. |
SQ_ErrorCode SQ_IsLagged | ( | SQ_Variable | pVariable, |
SQ_Bool * | bIsLagged | ||
) |
Gets information whether the variable has been lagged or not. Only valid if the variable is from a model.
[in] | pVariable | The variable to get the name of. |
[out] | bIsLagged | SQ_True if the variable is lagged. |
SQ_ErrorCode SQ_IsPhaseIterationVariable | ( | SQ_Variable | pVariable, |
SQ_Bool * | bIsPhaseIterVariable | ||
) |
Gets information whether the variable is phase iteration condition or not. Only valid if the variable is from a model.
[in] | pVariable | The variable to get the information of. |
[out] | bIsPhaseIterVariable | SQ_True if the variable is a phase iteration condition variable. |
SQ_ErrorCode SQ_IsQualitative | ( | SQ_Variable | pVariable, |
SQ_Bool * | bIsQualitative | ||
) |
Gets information whether the variable is qualitative or not.
[in] | pVariable | The variable to get the name of. |
[out] | bIsQualitative | SQ_True if the variable is qualitative. |
SQ_ErrorCode SQ_IsXVariable | ( | SQ_Variable | pVariable, |
SQ_Bool * | bIsXVariable | ||
) |
Gets information whether the variable belongs to the X or Y block. Only valid if the variable is from a model.
[in] | pVariable | The variable to get the name of. |
[out] | bIsXVariable | SQ_True if the variable is an X variable. |
Copyright (C) Sartorius Stedim Data Analytics AB - Generated by Doxygen