Classes | Typedefs | Functions
SQBatchModel.h File Reference
#include "SQDef.h"
#include "SQErrorCodes.h"
#include "SQModel.h"

Go to the source code of this file.

Classes

struct  tagSQ_BatchModel
 

Typedefs

typedef struct tagSQ_BatchModelSQ_BatchModel
 

Functions

SQ_ErrorCode SQ_GetNumberOfBLM (SQ_BatchModel pBatchModel, int *piNumBLM)
 
SQ_ErrorCode SQ_GetBatchLevelModelNumber (SQ_BatchModel pBatchModel, int iBLMIndex, int *piBLModelNumber)
 
SQ_ErrorCode SQ_GetBatchLevelModel (SQ_BatchModel pBatchModel, int iBLModelNumber, SQ_Model *pBatchLevelModel)
 
SQ_ErrorCode SQ_GetNumberOfBEM (SQ_BatchModel pBatchModel, int *piNumBEM)
 
SQ_ErrorCode SQ_GetBatchEvolutionModelNumber (SQ_BatchModel pBatchModel, int iBEMIndex, int *piBEModelNumber)
 
SQ_ErrorCode SQ_GetBatchEvolutionModel (SQ_BatchModel pBatchModel, int iBEModelNumber, SQ_Model *pBatchEvolutionModel)
 

Typedef Documentation

◆ SQ_BatchModel

typedef struct tagSQ_BatchModel * SQ_BatchModel

The object used to identify a Batch model (BM). IMPORTANT: Always initialize it to NULL!

Function Documentation

◆ SQ_GetBatchEvolutionModel()

SQ_ErrorCode SQ_GetBatchEvolutionModel ( SQ_BatchModel  pBatchModel,
int  iBEModelNumber,
SQ_Model pBatchEvolutionModel 
)

Get a Batch Evolution Model in this BM.

Parameters
[in]pBatchModelThe batch model to use
[in]iBEModelNumberThe Batch Evolution Model number.
[out]pBatchEvolutionModelThe Batch Evolution Model.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetBatchEvolutionModelNumber()

SQ_ErrorCode SQ_GetBatchEvolutionModelNumber ( SQ_BatchModel  pBatchModel,
int  iBEMIndex,
int *  piBEModelNumber 
)

Get the model number of a Batch Evolution Model in this BM.

Parameters
[in]pBatchModelThe batch model to use
[in]iBEMIndexThe index of the BEM in this BM.
[out]piBEModelNumberThe BE Model number.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetBatchLevelModel()

SQ_ErrorCode SQ_GetBatchLevelModel ( SQ_BatchModel  pBatchModel,
int  iBLModelNumber,
SQ_Model pBatchLevelModel 
)

Get a Batch Level Model in this BM.

Parameters
[in]pBatchModelThe batch model to use
[in]iBLModelNumberThe Batch Level Model number.
[out]pBatchLevelModelThe Batch Level Model.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetBatchLevelModelNumber()

SQ_ErrorCode SQ_GetBatchLevelModelNumber ( SQ_BatchModel  pBatchModel,
int  iBLMIndex,
int *  piBLModelNumber 
)

Get the model number of a Batch Level Model in this BM.

Parameters
[in]pBatchModelThe batch model to use
[in]iBLMIndexThe index of the BLM in this BM.
[out]piBLModelNumberThe BL Model number.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetNumberOfBEM()

SQ_ErrorCode SQ_GetNumberOfBEM ( SQ_BatchModel  pBatchModel,
int *  piNumBEM 
)

Get the number of Batch Evolution Models connected to this BM.

Parameters
[in]pBatchModelThe batch model to use
[out]piNumBEMNumber of Batch Evolution Models in this BM.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetNumberOfBLM()

SQ_ErrorCode SQ_GetNumberOfBLM ( SQ_BatchModel  pBatchModel,
int *  piNumBLM 
)

Get the number of Batch Level Models connected to this BM.

Parameters
[in]pBatchModelThe batch model to use
[out]piNumBLMNumber of Batch Level Models in this BM.
Returns
Returns SQ_E_OK if success or an error code

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