SQMWorkset.h
Go to the documentation of this file.
1 /*
2 Copyright (C) Sartorius Stedim Data Analytics AB 2017 -
3 */
4 #ifndef _SQMWORKSET_H_
5 #define _SQMWORKSET_H_
6 
7 #include "SQDef.h"
8 
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15 
16 #ifdef _WIN32
17 #pragma pack(push, 8)
18 #endif
19 
20 #include "SQErrorCodes.h"
21 #include "SQCommon.h"
22 #include "SQMDefines.h"
23 
25 
30  typedef struct tagSQ_WorksetHandle
31  {
33  void* reserved;
34  } *SQ_Workset;
35 
36 
45  SQCEXPORT SQ_ErrorCode SQCDECL SQ_ReleaseWorkset(SQ_Workset hWorkset);
46 
54  SQCEXPORT SQ_ErrorCode SQCDECL SQ_AddDataset(SQ_Workset hWorkset, int iDatasetNumber);
55 
65  SQCEXPORT SQ_ErrorCode SQCDECL SQ_AddObservations(SQ_Workset hWorkset, int iDatasetNumber, SQ_IntVector vecObservationIndices, SQ_IntVector *piWorksetIndices);
66 
97  SQCEXPORT SQ_ErrorCode SQCDECL SQ_AddVariable(SQ_Workset hWorkset, int iDatasetNumber, SQ_IntVector hDSVariableIndices, SQ_FloatVector* pLags, SQ_IntVector* pLagTimeVariable, SQ_IntVector* pLagSpeedVariable, SQ_VariableBlock eBlock, int *hWorksetIndex);
98 
108  SQCEXPORT SQ_ErrorCode SQCDECL SQ_CreateDefaultWorkset(SQ_Workset hWorkset);
109 
119  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetWorksetDescription(SQ_Workset hWorkset, const char *szDescription);
120 
129  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetWorksetDescription(SQ_Workset hWorkset, char *szDescription, int iBufferLen);
130 
139  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetVariableSize(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int *pSize);
140 
150  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetMissingValueToleranceObs(SQ_Workset hWorkset, float *pfFractionTolerated);
160  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetMissingValueToleranceVar(SQ_Workset hWorkset, float *pfFractionTolerated);
161 
172  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetMissingValueToleranceObs(SQ_Workset hWorkset, float fFractionTolerated);
183  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetMissingValueToleranceVar(SQ_Workset hWorkset, float fFractionTolerated);
184 
192  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetKeepLowVarianceVariables(SQ_Workset hWorkset, SQ_Bool bKeepVariables);
193 
203  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetLongScalingName(SQ_WSScaleInfo *pScaleInfo, char *szName, int iBufferLen);
204 
215  SQCEXPORT SQ_ErrorCode SQCDECL SQ_CreateModel(SQ_Workset hWorkset, SQ_Bool bCreateClassModels, SQ_ModelType eModelType, SQ_IntVector* pModelNumbers);
216 
224  SQCEXPORT SQ_ErrorCode SQCDECL SQ_UpdateModel(SQ_Workset hWorkset);
225 
226 
237  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetObservationClass(SQ_Workset hWorkset, int iWorksetObservationIndex, int *piClassNo);
249  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetVariableClass(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetVariableIndex, SQ_IntVector *piClasses);
259  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetWorksetClasses(SQ_Workset hWorkset, SQ_IntVector *piClasses);
260 
261 
272  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetScaling(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex, SQ_WSScaleInfo *pScaleInfo);
273 
283  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetLongTransformName(SQ_WSTransformInfo *pTransformInfo, char* szName, int iBufferLen);
284 
297  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetWorksetObservationName(SQ_Workset hWorkset, int iWorksetIndex, int iID, char* szName, int iBufferLen);
305  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetWorksetObservationSize(SQ_Workset hWorkset, int *piSize);
315  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetShortScalingName(SQ_WSScaleInfo *pScaleInfo, char* szName, int iBufferLen);
325  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetShortTransformName(SQ_WSTransformInfo *pTransformInfo, char* szName, int iBufferLen);
335  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetTransform(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iIndex, SQ_WSTransformInfo *pTransformInfo);
336 
346  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetWorksetClassName(SQ_Workset hWorkset, int iClassNo, char* szName, int iBufferLen);
347 
356  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetWorksetClassName(SQ_Workset hWorkset, int iClassNo, const char *szName);
365  SQCEXPORT SQ_ErrorCode SQCDECL SQ_AutogenerateClasses(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex);
366 
381  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetScaling(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex, SQ_WSScaleInfo *pScaleInfo);
393  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetTransform(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex, SQ_WSTransformInfo *pTransformInfo);
394 
404  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetAutoTransformAll(SQ_Workset hWorkset, SQ_Bool bAutoTransformAllIfOneNeddsTransform);
405 
417  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetObservationClass(SQ_Workset hWorkset, int iWorksetObservationIndex, int iClassNo);
427  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetObservationClasses(SQ_Workset hWorkset, SQ_IntVector* pClasses);
428 
441  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetVariableClass(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex, int iClassNo);
442 
451  SQCEXPORT SQ_ErrorCode SQCDECL SQ_RemoveObservation(SQ_Workset hWorkset, int iWorksetIndex);
452 
462  SQCEXPORT SQ_ErrorCode SQCDECL SQ_RemoveVariable(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex);
463 
473  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetObservationWorksetIndex(SQ_Workset hWorkset, int iDSIndex, int *hWorksetIndex);
474 
484  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetObservationDatasetIndex(SQ_Workset hWorkset, int iWorksetIndex, int *pDatasetIndex);
485 
514  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetVariableWorksetIndex(SQ_Workset hWorkset, int iDatasetNumber, SQ_IntVector pDSVariableIndices, SQ_FloatVector* pLags, SQ_IntVector* pLagTimeVariable, SQ_IntVector* pLagSpeedVariable, SQ_VariableBlock eSQBlock, int *pWorksetIndex);
515 
529  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetVariableWorksetName(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iIndex, int iID, char* szName, int iBufferLen);
530 
531 
552  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetVariable(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iIndex, int* iDSNumber, SQ_IntVector* pDSVariableIndices, SQ_FloatVector* pLags, SQ_IntVector* pLagTimeVariable, SQ_IntVector* pLagSpeedVariable);
553 
555 
556 #ifdef _WIN32
557 #pragma pack(pop)
558 #endif
559 
560 #ifdef __cplusplus
561 }
562 #endif /*__cplusplus*/
563 
564 #endif /* _SQMWORKSET_H_ */
SQ_GetWorksetObservationSize
SQ_ErrorCode SQ_GetWorksetObservationSize(SQ_Workset hWorkset, int *piSize)
tagSQ_FloatVector
Definition: SQFloatVector.h:27
SQ_GetLongTransformName
SQ_ErrorCode SQ_GetLongTransformName(SQ_WSTransformInfo *pTransformInfo, char *szName, int iBufferLen)
SQ_SetTransform
SQ_ErrorCode SQ_SetTransform(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex, SQ_WSTransformInfo *pTransformInfo)
tagSQ_WorksetHandle
Definition: SQMWorkset.h:30
SQ_WSScaleInfoStruct
Definition: SQMDefines.h:118
SQ_SetScaling
SQ_ErrorCode SQ_SetScaling(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex, SQ_WSScaleInfo *pScaleInfo)
SQ_GetWorksetClassName
SQ_ErrorCode SQ_GetWorksetClassName(SQ_Workset hWorkset, int iClassNo, char *szName, int iBufferLen)
SQ_ModelType
enum SQ_ModelTypeEnum SQ_ModelType
SQ_Bool
enum SQ_BoolEnum SQ_Bool
SQ_GetVariableSize
SQ_ErrorCode SQ_GetVariableSize(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int *pSize)
SQ_GetVariableWorksetName
SQ_ErrorCode SQ_GetVariableWorksetName(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iIndex, int iID, char *szName, int iBufferLen)
SQ_WSTransformInfoStruct
Definition: SQMDefines.h:191
SQ_GetTransform
SQ_ErrorCode SQ_GetTransform(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iIndex, SQ_WSTransformInfo *pTransformInfo)
SQCommon.h
tagSQ_WorksetHandle::reserved
void * reserved
Definition: SQMWorkset.h:33
SQ_VariableBlock
enum SQ_BlockTypeEnum SQ_VariableBlock
SQ_GetShortTransformName
SQ_ErrorCode SQ_GetShortTransformName(SQ_WSTransformInfo *pTransformInfo, char *szName, int iBufferLen)
SQ_CreateModel
SQ_ErrorCode SQ_CreateModel(SQ_Workset hWorkset, SQ_Bool bCreateClassModels, SQ_ModelType eModelType, SQ_IntVector *pModelNumbers)
SQ_GetScaling
SQ_ErrorCode SQ_GetScaling(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex, SQ_WSScaleInfo *pScaleInfo)
SQ_GetLongScalingName
SQ_ErrorCode SQ_GetLongScalingName(SQ_WSScaleInfo *pScaleInfo, char *szName, int iBufferLen)
SQ_GetMissingValueToleranceVar
SQ_ErrorCode SQ_GetMissingValueToleranceVar(SQ_Workset hWorkset, float *pfFractionTolerated)
SQ_SetMissingValueToleranceVar
SQ_ErrorCode SQ_SetMissingValueToleranceVar(SQ_Workset hWorkset, float fFractionTolerated)
SQ_GetObservationDatasetIndex
SQ_ErrorCode SQ_GetObservationDatasetIndex(SQ_Workset hWorkset, int iWorksetIndex, int *pDatasetIndex)
SQ_ReleaseWorkset
SQ_ErrorCode SQ_ReleaseWorkset(SQ_Workset hWorkset)
SQ_RemoveVariable
SQ_ErrorCode SQ_RemoveVariable(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex)
tagSQ_IntVector
Definition: SQIntVector.h:27
SQ_Workset
struct tagSQ_WorksetHandle * SQ_Workset
SQ_GetVariableClass
SQ_ErrorCode SQ_GetVariableClass(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetVariableIndex, SQ_IntVector *piClasses)
SQ_SetObservationClasses
SQ_ErrorCode SQ_SetObservationClasses(SQ_Workset hWorkset, SQ_IntVector *pClasses)
SQ_AddDataset
SQ_ErrorCode SQ_AddDataset(SQ_Workset hWorkset, int iDatasetNumber)
SQ_GetVariableWorksetIndex
SQ_ErrorCode SQ_GetVariableWorksetIndex(SQ_Workset hWorkset, int iDatasetNumber, SQ_IntVector pDSVariableIndices, SQ_FloatVector *pLags, SQ_IntVector *pLagTimeVariable, SQ_IntVector *pLagSpeedVariable, SQ_VariableBlock eSQBlock, int *pWorksetIndex)
SQ_RemoveObservation
SQ_ErrorCode SQ_RemoveObservation(SQ_Workset hWorkset, int iWorksetIndex)
SQ_CreateDefaultWorkset
SQ_ErrorCode SQ_CreateDefaultWorkset(SQ_Workset hWorkset)
SQ_SetWorksetDescription
SQ_ErrorCode SQ_SetWorksetDescription(SQ_Workset hWorkset, const char *szDescription)
SQ_SetWorksetClassName
SQ_ErrorCode SQ_SetWorksetClassName(SQ_Workset hWorkset, int iClassNo, const char *szName)
SQ_ErrorCode
enum SQ_ErrorCodeEnum SQ_ErrorCode
SQ_AddVariable
SQ_ErrorCode SQ_AddVariable(SQ_Workset hWorkset, int iDatasetNumber, SQ_IntVector hDSVariableIndices, SQ_FloatVector *pLags, SQ_IntVector *pLagTimeVariable, SQ_IntVector *pLagSpeedVariable, SQ_VariableBlock eBlock, int *hWorksetIndex)
SQ_GetMissingValueToleranceObs
SQ_ErrorCode SQ_GetMissingValueToleranceObs(SQ_Workset hWorkset, float *pfFractionTolerated)
SQ_GetObservationClass
SQ_ErrorCode SQ_GetObservationClass(SQ_Workset hWorkset, int iWorksetObservationIndex, int *piClassNo)
SQ_GetShortScalingName
SQ_ErrorCode SQ_GetShortScalingName(SQ_WSScaleInfo *pScaleInfo, char *szName, int iBufferLen)
SQ_GetObservationWorksetIndex
SQ_ErrorCode SQ_GetObservationWorksetIndex(SQ_Workset hWorkset, int iDSIndex, int *hWorksetIndex)
SQ_SetMissingValueToleranceObs
SQ_ErrorCode SQ_SetMissingValueToleranceObs(SQ_Workset hWorkset, float fFractionTolerated)
SQ_GetWorksetDescription
SQ_ErrorCode SQ_GetWorksetDescription(SQ_Workset hWorkset, char *szDescription, int iBufferLen)
SQ_SetKeepLowVarianceVariables
SQ_ErrorCode SQ_SetKeepLowVarianceVariables(SQ_Workset hWorkset, SQ_Bool bKeepVariables)
SQ_GetVariable
SQ_ErrorCode SQ_GetVariable(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iIndex, int *iDSNumber, SQ_IntVector *pDSVariableIndices, SQ_FloatVector *pLags, SQ_IntVector *pLagTimeVariable, SQ_IntVector *pLagSpeedVariable)
SQMDefines.h
SQ_AddObservations
SQ_ErrorCode SQ_AddObservations(SQ_Workset hWorkset, int iDatasetNumber, SQ_IntVector vecObservationIndices, SQ_IntVector *piWorksetIndices)
SQ_SetObservationClass
SQ_ErrorCode SQ_SetObservationClass(SQ_Workset hWorkset, int iWorksetObservationIndex, int iClassNo)
SQ_UpdateModel
SQ_ErrorCode SQ_UpdateModel(SQ_Workset hWorkset)
SQErrorCodes.h
SQ_GetWorksetObservationName
SQ_ErrorCode SQ_GetWorksetObservationName(SQ_Workset hWorkset, int iWorksetIndex, int iID, char *szName, int iBufferLen)
SQ_SetVariableClass
SQ_ErrorCode SQ_SetVariableClass(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex, int iClassNo)
SQ_AutogenerateClasses
SQ_ErrorCode SQ_AutogenerateClasses(SQ_Workset hWorkset, SQ_VariableBlock eBlock, int iWorksetIndex)
SQ_GetWorksetClasses
SQ_ErrorCode SQ_GetWorksetClasses(SQ_Workset hWorkset, SQ_IntVector *piClasses)
SQ_SetAutoTransformAll
SQ_ErrorCode SQ_SetAutoTransformAll(SQ_Workset hWorkset, SQ_Bool bAutoTransformAllIfOneNeddsTransform)

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