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

Go to the source code of this file.

Classes

struct  tagSQ_IntVector
 

Typedefs

typedef struct tagSQ_IntVectorSQ_IntVector
 

Functions

SQ_ErrorCode SQ_InitIntVector (SQ_IntVector *pVector, int iSize)
 
SQ_ErrorCode SQ_CopyIntVector (SQ_IntVector pInVector, SQ_IntVector *pOutVector)
 
SQ_ErrorCode SQ_ClearIntVector (SQ_IntVector *pVector)
 
SQ_ErrorCode SQ_SetDataInIntVector (SQ_IntVector pVector, int iPos, int iVal)
 
SQ_ErrorCode SQ_GetDataFromIntVector (const SQ_IntVector pVector, int iPos, int *piVal)
 
SQ_ErrorCode SQ_SetIntVector (SQ_IntVector pVector, const int *piVals)
 
SQ_ErrorCode SQ_GetIntVector (const SQ_IntVector pVector, int *piVals)
 
SQ_ErrorCode SQ_GetIntVectorSize (const SQ_IntVector pVector, int *piSize)
 

Detailed Description

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

Typedef Documentation

◆ SQ_IntVector

typedef struct tagSQ_IntVector * SQ_IntVector

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

Function Documentation

◆ SQ_ClearIntVector()

SQ_ErrorCode SQ_ClearIntVector ( SQ_IntVector pVector)

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

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

◆ SQ_CopyIntVector()

SQ_ErrorCode SQ_CopyIntVector ( SQ_IntVector  pInVector,
SQ_IntVector pOutVector 
)

Get a copy of the int vector

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

◆ SQ_GetDataFromIntVector()

SQ_ErrorCode SQ_GetDataFromIntVector ( const SQ_IntVector  pVector,
int  iPos,
int *  piVal 
)

Gets the data from a given position.

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

◆ SQ_GetIntVector()

SQ_ErrorCode SQ_GetIntVector ( const SQ_IntVector  pVector,
int *  piVals 
)

Gets the data from the vector.

See also
tagSQ_IntVector
Parameters
[in]pVectorThe vector to get the data from.
[in]piValsAn array to be filled with the data from the vector. Must be at least of same size as the vector.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetIntVectorSize()

SQ_ErrorCode SQ_GetIntVectorSize ( const SQ_IntVector  pVector,
int *  piSize 
)

Returns the size of the vector.

See also
tagSQ_IntVector
Parameters
[in]pVectorThe vector to get the size of.
[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_InitIntVector()

SQ_ErrorCode SQ_InitIntVector ( SQ_IntVector pVector,
int  iSize 
)

Initialize an integer vector with its size.

See also
tagSQ_IntVector
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_SetDataInIntVector()

SQ_ErrorCode SQ_SetDataInIntVector ( SQ_IntVector  pVector,
int  iPos,
int  iVal 
)

Sets the data at the given position.

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

◆ SQ_SetIntVector()

SQ_ErrorCode SQ_SetIntVector ( SQ_IntVector  pVector,
const int *  piVals 
)

Sets the data in the vector.

See also
tagSQ_IntVector
Parameters
[in]pVectorThe vector to set the data in.
[in]piValsAn array of data to fill the vector with. Must be at least of same size as the vector.
Returns
Returns SQ_E_OK if success or an error code

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