Classes | Typedefs | Functions
SQBoolVector.h File Reference
#include "SQDef.h"
#include "SQErrorCodes.h"
#include "SQCommon.h"

Go to the source code of this file.

Classes

struct  tagSQ_BoolVector
 

Typedefs

typedef struct tagSQ_BoolVectorSQ_BoolVector
 

Functions

SQ_ErrorCode SQ_InitBoolVector (SQ_BoolVector *pVector, int iSize)
 
SQ_ErrorCode SQ_CopyBoolVector (SQ_BoolVector pInVector, SQ_BoolVector *pOutVector)
 
SQ_ErrorCode SQ_ClearBoolVector (SQ_BoolVector *pVector)
 
SQ_ErrorCode SQ_SetDataInBoolVector (SQ_BoolVector pVector, int iPos, SQ_Bool bVal)
 
SQ_ErrorCode SQ_GetDataFromBoolVector (const SQ_BoolVector pVector, int iPos, SQ_Bool *pbVal)
 
SQ_ErrorCode SQ_GetBoolVectorSize (const SQ_BoolVector pVector, int *piSize)
 

Detailed Description

This file list the SQ_BoolVector object used in Umetrics SIMCA-Q products.

Typedef Documentation

◆ SQ_BoolVector

typedef struct tagSQ_BoolVector * SQ_BoolVector

An bool vector that is used to get and send data to some functions. Index base = 1. IMPORTANT: Always initialize it to NULL!

Function Documentation

◆ SQ_ClearBoolVector()

SQ_ErrorCode SQ_ClearBoolVector ( SQ_BoolVector pVector)

Removes the vector, this function must be called for every vector that is created.

See also
tagSQ_BoolVector
Parameters
[in]pVectorThe vector to be removed.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_CopyBoolVector()

SQ_ErrorCode SQ_CopyBoolVector ( SQ_BoolVector  pInVector,
SQ_BoolVector pOutVector 
)

Get a copy of the bool vector

See also
tagSQ_BoolVector
Parameters
[in]pInVectorThe vector to copy.
[in,out]pOutVectorThe result vector.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetBoolVectorSize()

SQ_ErrorCode SQ_GetBoolVectorSize ( const SQ_BoolVector  pVector,
int *  piSize 
)

Returns the size of the vector.

See also
tagSQ_BoolVector
Parameters
[in]pVectorThe vector to get the number of columns from.
[out]piSizeThe size of the vector or a negative number if an error occurred.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetDataFromBoolVector()

SQ_ErrorCode SQ_GetDataFromBoolVector ( const SQ_BoolVector  pVector,
int  iPos,
SQ_Bool pbVal 
)

Gets the data from a given position.

See also
tagSQ_BoolVector
Parameters
[in]pVectorThe vector to get the data from.
[in]iPosThe position to get the data from.
[in]pbValThe data in the cell.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_InitBoolVector()

SQ_ErrorCode SQ_InitBoolVector ( SQ_BoolVector pVector,
int  iSize 
)

Initialize a boolean vector with its size.

See also
tagSQ_BoolVector
Parameters
[in]pVectorThe vector to be initialized.
[out]iSizeThe size of the vector.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_SetDataInBoolVector()

SQ_ErrorCode SQ_SetDataInBoolVector ( SQ_BoolVector  pVector,
int  iPos,
SQ_Bool  bVal 
)

Sets the data at the given position.

See also
tagSQ_BoolVector
Parameters
[in]pVectorThe vector to set the data in.
[in]iPosThe position to set the data in.
[in]bValThe data to set the cell with.
Returns
Returns SQ_E_OK if success or an error code

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