SQDataset.h
Go to the documentation of this file.
1 /*
2 Copyright (C) Sartorius Stedim Data Analytics AB 2017 -
3 */
4 #ifndef _SQDATASET_H_
5 #define _SQDATASET_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 "SQStringVector.h"
23 #include "SQIntVector.h"
24 #include "SQVectorData.h"
25 #include "SQVariable.h"
26 
31  typedef struct tagSQ_Dataset
32  {
34  void* reserved;
35  } *SQ_Dataset;
36 
40  typedef enum SQ_DatasetTypeEnum
41  {
51 
55  typedef struct tagSQ_DatasetTypeVector
56  {
58  void* reserved;
60 
68  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetSizeOfDatasetTypeVector(const SQ_DatasetTypeVector pVector, int* piSize);
69 
78  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataFromDatasetTypeVector(const SQ_DatasetTypeVector pVector, int iPos, SQ_DatasetType* pDatasetType);
79 
80  /*******************************************************************************************
81  *
82  * Functions for the datasets
83  *
84  * All these functions take a SQ_Dataset as parameter.
85  * The SQ_Dataset object is retrieved from SQ_GetDataset.
86  * Information from these functions comes from the datasets.
87  * All functions return an error code that indicates whether the function succeeded or failed.
88  *
89  ********************************************************************************************/
90 
100  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetName(SQ_Dataset pDataset, char *szDatasetName, int iBufferLength);
101 
110  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetTypes(SQ_Dataset pDataset, SQ_DatasetTypeVector* pTypeVector);
120  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetNumberOfVariableIDs(SQ_Dataset pDataset, int *piNrVarIDs);
130  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetNumberOfObservationIDs(SQ_Dataset pDataset, int *piNrObsIDs);
138  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetVariableNames(SQ_Dataset pDataset, SQ_VariableVector *pVariableVector);
148  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetOriginalDataSetVariableNames(SQ_Dataset pDataset, SQ_VariableVector *pVariableVector);
163  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetVariableIDName(SQ_Dataset pDataset, int iNameIDIndex, char *pszVariableIDName, int iBufferLength);
177  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetObservationNames(SQ_Dataset pDataset, int iNameIDIndex, SQ_StringVector *pObservationNames);
192  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetObservationIDName(SQ_Dataset pDataset, int iNameIDIndex, char *pszObservationIDName, int iBufferLength);
207  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetObservations(SQ_Dataset pDataset, SQ_IntVector* pObservations, SQ_VectorData* pVectorData);
221  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetVariables(SQ_Dataset pDataset, SQ_IntVector* pVariables, SQ_VectorData* pVectorData);
222 
223 #ifdef _WIN32
224 #pragma pack(pop)
225 #endif
226 
227 #ifdef __cplusplus
228 }
229 #endif /*__cplusplus*/
230 
231 
232 #endif /* _SQDATASET_H_ */
SQ_GetDataSetObservationNames
SQ_ErrorCode SQ_GetDataSetObservationNames(SQ_Dataset pDataset, int iNameIDIndex, SQ_StringVector *pObservationNames)
SQ_GetDataSetVariables
SQ_ErrorCode SQ_GetDataSetVariables(SQ_Dataset pDataset, SQ_IntVector *pVariables, SQ_VectorData *pVectorData)
tagSQ_Dataset
Definition: SQDataset.h:31
SQ_GetDataSetTypes
SQ_ErrorCode SQ_GetDataSetTypes(SQ_Dataset pDataset, SQ_DatasetTypeVector *pTypeVector)
SQ_GetDataSetVariableIDName
SQ_ErrorCode SQ_GetDataSetVariableIDName(SQ_Dataset pDataset, int iNameIDIndex, char *pszVariableIDName, int iBufferLength)
SQ_GetNumberOfObservationIDs
SQ_ErrorCode SQ_GetNumberOfObservationIDs(SQ_Dataset pDataset, int *piNrObsIDs)
SQ_D_PLSDA
@ SQ_D_PLSDA
Definition: SQDataset.h:45
SQ_D_BatchCondition
@ SQ_D_BatchCondition
Definition: SQDataset.h:48
SQ_GetSizeOfDatasetTypeVector
SQ_ErrorCode SQ_GetSizeOfDatasetTypeVector(const SQ_DatasetTypeVector pVector, int *piSize)
SQVectorData.h
tagSQ_DatasetTypeVector::reserved
void * reserved
Definition: SQDataset.h:58
SQ_GetOriginalDataSetVariableNames
SQ_ErrorCode SQ_GetOriginalDataSetVariableNames(SQ_Dataset pDataset, SQ_VariableVector *pVariableVector)
SQ_DatasetType
enum SQ_DatasetTypeEnum SQ_DatasetType
SQVariable.h
tagSQ_IntVector
Definition: SQIntVector.h:27
SQIntVector.h
SQ_DatasetTypeEnum
SQ_DatasetTypeEnum
Definition: SQDataset.h:40
SQ_GetNumberOfVariableIDs
SQ_ErrorCode SQ_GetNumberOfVariableIDs(SQ_Dataset pDataset, int *piNrVarIDs)
SQ_D_ObservationLevel
@ SQ_D_ObservationLevel
Definition: SQDataset.h:47
tagSQ_VariableVector
Definition: SQVariable.h:30
SQ_Dataset
struct tagSQ_Dataset * SQ_Dataset
SQ_D_Standard
@ SQ_D_Standard
Definition: SQDataset.h:42
tagSQ_StringVector
Definition: SQStringVector.h:27
SQ_D_BatchLevel
@ SQ_D_BatchLevel
Definition: SQDataset.h:46
SQ_D_Spectral
@ SQ_D_Spectral
Definition: SQDataset.h:43
SQ_GetDataSetObservations
SQ_ErrorCode SQ_GetDataSetObservations(SQ_Dataset pDataset, SQ_IntVector *pObservations, SQ_VectorData *pVectorData)
SQ_ErrorCode
enum SQ_ErrorCodeEnum SQ_ErrorCode
SQ_GetDataSetVariableNames
SQ_ErrorCode SQ_GetDataSetVariableNames(SQ_Dataset pDataset, SQ_VariableVector *pVariableVector)
SQ_GetDataSetName
SQ_ErrorCode SQ_GetDataSetName(SQ_Dataset pDataset, char *szDatasetName, int iBufferLength)
tagSQ_DatasetTypeVector
Definition: SQDataset.h:55
SQ_GetDataSetObservationIDName
SQ_ErrorCode SQ_GetDataSetObservationIDName(SQ_Dataset pDataset, int iNameIDIndex, char *pszObservationIDName, int iBufferLength)
SQStringVector.h
SQErrorCodes.h
SQ_DatasetTypeVector
struct tagSQ_DatasetTypeVector * SQ_DatasetTypeVector
SQ_D_Hierarchical
@ SQ_D_Hierarchical
Definition: SQDataset.h:44
tagSQ_Dataset::reserved
void * reserved
Definition: SQDataset.h:34
SQ_GetDataFromDatasetTypeVector
SQ_ErrorCode SQ_GetDataFromDatasetTypeVector(const SQ_DatasetTypeVector pVector, int iPos, SQ_DatasetType *pDatasetType)
tagSQ_VectorData
Definition: SQVectorData.h:29
SQ_D_LagDistance
@ SQ_D_LagDistance
Definition: SQDataset.h:49

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