Classes | Typedefs | Functions
SQBatchPrediction.h File Reference
#include "SQDef.h"
#include "SQErrorCodes.h"
#include "SQPrediction.h"

Go to the source code of this file.

Classes

struct  tagSQ_BatchPrediction
 

Typedefs

typedef struct tagSQ_BatchPredictionSQ_BatchPrediction
 

Functions

SQ_ErrorCode SQ_ClearBatchPrediction (SQ_BatchPrediction *pPrediction)
 
SQ_ErrorCode SQ_GetBatchLevelPrediction (SQ_BatchPrediction pBatchPrediction, SQ_Prediction *pBLPrediction)
 
SQ_ErrorCode SQ_GetBatchEvolutionPrediction (SQ_BatchPrediction pBatchPrediction, int iModelNumber, SQ_Prediction *pBEMPrediction)
 

Detailed Description

This file list the SQ_BatchPrediction object used to get data from a batch prediction.

Typedef Documentation

◆ SQ_BatchPrediction

The handle used to identify a prediction object. IMPORTANT: Always initialize it to NULL!

Function Documentation

◆ SQ_ClearBatchPrediction()

SQ_ErrorCode SQ_ClearBatchPrediction ( SQ_BatchPrediction pPrediction)

Removes the allocated memory for the BatchPrediction object. This function must be called for every BatchPrediction object that is created, if not a memory leak will occur.

Parameters
[in]pPredictionThe Batch Prediction object to remove.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetBatchEvolutionPrediction()

SQ_ErrorCode SQ_GetBatchEvolutionPrediction ( SQ_BatchPrediction  pBatchPrediction,
int  iModelNumber,
SQ_Prediction pBEMPrediction 
)

Get the prediction handle for a batch evolution model that the prediction was performed on.

Parameters
[in]pBatchPredictionThe batch prediction object to use.
[in]iModelNumberThe batch evolution model number to get the prediction for.
[out]pBEMPredictionThe batch evolution prediction object that should be used to retrieve the prediction results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetBatchLevelPrediction()

SQ_ErrorCode SQ_GetBatchLevelPrediction ( SQ_BatchPrediction  pBatchPrediction,
SQ_Prediction pBLPrediction 
)

Get the prediction handle for the batch level model that the prediction was performed on.

Parameters
[in]pBatchPredictionThe batch prediction object to use.
[out]pBLPredictionThe batch level prediction object that should be used to retrieve the prediction results.
Returns
Returns SQ_E_OK if success or an error code

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