SQDataset.h

Go to the documentation of this file.

/*
Copyright (C) Sartorius Stedim Data Analytics AB 2017 -
*/
#ifndef _SQDATASET_H_
#define _SQDATASET_H_
 
#include "SQDef.h"
 
#ifdef __cplusplus
extern "C" {
#endif 
 
#ifdef _WIN32
#pragma pack(push, 8)
#endif
 
#include "SQErrorCodes.h"
#include "SQStringVector.h"
#include "SQIntVector.h"
#include "SQVectorData.h"
#include "SQVariable.h"
 
   typedef struct tagSQ_Dataset 
   {
      void* reserved;
   } *SQ_Dataset;
 
   typedef enum SQ_DatasetTypeEnum
   {
      SQ_D_Standard=0,        
      SQ_D_Spectral,          
      SQ_D_Hierarchical,      
      SQ_D_PLSDA,             
      SQ_D_BatchLevel,        
      SQ_D_ObservationLevel,  
      SQ_D_BatchCondition,    
          SQ_D_LagDistance        
   } SQ_DatasetType;
 
   typedef struct tagSQ_DatasetTypeVector 
   {
      void* reserved;
   } *SQ_DatasetTypeVector;
 
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetSizeOfDatasetTypeVector(const SQ_DatasetTypeVector pVector, int* piSize);
 
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataFromDatasetTypeVector(const SQ_DatasetTypeVector pVector, int iPos, SQ_DatasetType* pDatasetType);
 
   /*******************************************************************************************
   *
   *                       Functions for the datasets
   *
   *  All these functions take a SQ_Dataset as parameter. 
   *  The SQ_Dataset object is retrieved from SQ_GetDataset.
   *  Information from these functions comes from the datasets. 
   *  All functions return an error code that indicates whether the function succeeded or failed.
   *
   ********************************************************************************************/
 
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetName(SQ_Dataset pDataset, char *szDatasetName, int iBufferLength);
 
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetTypes(SQ_Dataset pDataset, SQ_DatasetTypeVector* pTypeVector);
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetNumberOfVariableIDs(SQ_Dataset pDataset, int *piNrVarIDs);
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetNumberOfObservationIDs(SQ_Dataset pDataset, int *piNrObsIDs);
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetVariableNames(SQ_Dataset pDataset, SQ_VariableVector *pVariableVector);
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetOriginalDataSetVariableNames(SQ_Dataset pDataset, SQ_VariableVector *pVariableVector);
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetVariableIDName(SQ_Dataset pDataset, int iNameIDIndex, char *pszVariableIDName, int iBufferLength);
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetObservationNames(SQ_Dataset pDataset, int iNameIDIndex, SQ_StringVector *pObservationNames);
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetObservationIDName(SQ_Dataset pDataset, int iNameIDIndex, char *pszObservationIDName, int iBufferLength);
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetObservations(SQ_Dataset pDataset, SQ_IntVector* pObservations, SQ_VectorData* pVectorData);
   SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataSetVariables(SQ_Dataset pDataset, SQ_IntVector* pVariables, SQ_VectorData* pVectorData);
 
#ifdef _WIN32
#pragma pack(pop)
#endif
 
#ifdef __cplusplus
}
#endif /*__cplusplus*/
 
 
#endif /* _SQDATASET_H_ */