SQVariable.h
Go to the documentation of this file.
1 /*
2 Copyright (C) Sartorius Stedim Data Analytics AB 2017 -
3 */
4 #ifndef _SQVARIABLE_H_
5 #define _SQVARIABLE_H_
6 
7 #include "SQDef.h"
8 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 #ifdef _WIN32
18 #pragma pack(push, 8)
19 #endif
20 
21 #include "SQErrorCodes.h"
22 #include "SQCommon.h"
23 #include "SQIntVector.h"
24 #include "SQStringVector.h"
25 
30  typedef struct tagSQ_VariableVector
31  {
33  void* reserved;
35 
39  typedef struct tagSQ_Variable
40  {
42  void* reserved;
43  } *SQ_Variable;
44 
45 /*********************************************************************************************************************
46  * SQ_VariableVector
47  *********************************************************************************************************************/
48 
56  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetNumVariablesInVector(SQ_VariableVector pVariables, int* iSize);
65  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetVariableFromVector(SQ_VariableVector pVariables, int iIndex, SQ_Variable* pVariable);
66 
67 /*********************************************************************************************************************
68  * SQ_Variable
69  *********************************************************************************************************************/
70 
82  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetVariableName(SQ_Variable pVariable, int iNameID, char* szVariableName, int iBufferLength);
90  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetVariableIDs(SQ_Variable pVariable, SQ_IntVector* pVariableIDs);
98  SQCEXPORT SQ_ErrorCode SQCDECL SQ_IsQualitative(SQ_Variable pVariable, SQ_Bool* bIsQualitative);
107  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetQualitativeSettings(SQ_Variable pVariable, SQ_StringVector *pSettings);
116  SQCEXPORT SQ_ErrorCode SQCDECL SQ_IsLagged(SQ_Variable pVariable, SQ_Bool* bIsLagged);
117 
126  SQCEXPORT SQ_ErrorCode SQCDECL SQ_HasDynamicLags(SQ_Variable pVariable, SQ_Bool* bHasDynamicLags);
127 
136  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetLagSteps(SQ_Variable pVariable, SQ_IntVector* pLagSteps);
137 
146  SQCEXPORT SQ_ErrorCode SQCDECL SQ_IsXVariable(SQ_Variable pVariable, SQ_Bool* bIsXVariable);
147 
156  SQCEXPORT SQ_ErrorCode SQCDECL SQ_IsPhaseIterationVariable(SQ_Variable pVariable, SQ_Bool* bIsPhaseIterVariable);
157 
158 #ifdef _WIN32
159 #pragma pack(pop)
160 #endif
161 
162 #ifdef __cplusplus
163 }
164 #endif /*__cplusplus*/
165 
166 #endif /* _SQVARIABLE_H_ */
SQ_IsQualitative
SQ_ErrorCode SQ_IsQualitative(SQ_Variable pVariable, SQ_Bool *bIsQualitative)
SQ_IsPhaseIterationVariable
SQ_ErrorCode SQ_IsPhaseIterationVariable(SQ_Variable pVariable, SQ_Bool *bIsPhaseIterVariable)
SQ_VariableVector
struct tagSQ_VariableVector * SQ_VariableVector
SQ_IsXVariable
SQ_ErrorCode SQ_IsXVariable(SQ_Variable pVariable, SQ_Bool *bIsXVariable)
SQ_Bool
enum SQ_BoolEnum SQ_Bool
SQ_GetQualitativeSettings
SQ_ErrorCode SQ_GetQualitativeSettings(SQ_Variable pVariable, SQ_StringVector *pSettings)
SQCommon.h
SQ_GetVariableIDs
SQ_ErrorCode SQ_GetVariableIDs(SQ_Variable pVariable, SQ_IntVector *pVariableIDs)
tagSQ_IntVector
Definition: SQIntVector.h:27
SQIntVector.h
tagSQ_VariableVector
Definition: SQVariable.h:30
tagSQ_StringVector
Definition: SQStringVector.h:27
SQ_Variable
struct tagSQ_Variable * SQ_Variable
SQ_GetNumVariablesInVector
SQ_ErrorCode SQ_GetNumVariablesInVector(SQ_VariableVector pVariables, int *iSize)
SQ_IsLagged
SQ_ErrorCode SQ_IsLagged(SQ_Variable pVariable, SQ_Bool *bIsLagged)
SQ_ErrorCode
enum SQ_ErrorCodeEnum SQ_ErrorCode
tagSQ_Variable
Definition: SQVariable.h:39
SQ_HasDynamicLags
SQ_ErrorCode SQ_HasDynamicLags(SQ_Variable pVariable, SQ_Bool *bHasDynamicLags)
tagSQ_Variable::reserved
void * reserved
Definition: SQVariable.h:42
SQ_GetLagSteps
SQ_ErrorCode SQ_GetLagSteps(SQ_Variable pVariable, SQ_IntVector *pLagSteps)
SQStringVector.h
SQErrorCodes.h
SQ_GetVariableName
SQ_ErrorCode SQ_GetVariableName(SQ_Variable pVariable, int iNameID, char *szVariableName, int iBufferLength)
SQ_GetVariableFromVector
SQ_ErrorCode SQ_GetVariableFromVector(SQ_VariableVector pVariables, int iIndex, SQ_Variable *pVariable)
tagSQ_VariableVector::reserved
void * reserved
Definition: SQVariable.h:33

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