Classes | Typedefs | Functions
SQVectorData.h File Reference
#include "SQDef.h"
#include "SQErrorCodes.h"
#include "SQFloatMatrix.h"
#include "SQStringVector.h"

Go to the source code of this file.

Classes

struct  tagSQ_VectorData
 

Typedefs

typedef struct tagSQ_VectorDataSQ_VectorData
 

Functions

SQ_ErrorCode SQ_ClearVectorData (SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetDataMatrix (SQ_VectorData pVectorData, SQ_FloatMatrix *pMatrix)
 
SQ_ErrorCode SQ_GetDataMatrixCopy (SQ_VectorData pVectorData, SQ_FloatMatrix *pMatrix)
 
SQ_ErrorCode SQ_GetRowNames (SQ_VectorData pVectorData, SQ_StringVector *pRowNames)
 
SQ_ErrorCode SQ_GetRowAliases (SQ_VectorData pVectorData, SQ_StringVector *pAliasNames)
 
SQ_ErrorCode SQ_GetRowNames2 (SQ_VectorData pVectorData, int iAlias, SQ_StringVector *pRowNames)
 
SQ_ErrorCode SQ_GetColumnNames (SQ_VectorData pVectorData, SQ_StringVector *pColumnNames)
 

Detailed Description

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

Typedef Documentation

◆ SQ_VectorData

typedef struct tagSQ_VectorData * SQ_VectorData

A vector data is used to get the results for requested vectors. It consists of a SQ_FloatMatrix with the data, a SQ_StringVector for the row names and a SQ_StringVector for the column names. IMPORTANT: Always initialize it to NULL!

Function Documentation

◆ SQ_ClearVectorData()

SQ_ErrorCode SQ_ClearVectorData ( SQ_VectorData pVectorData)

Removes the VectorData, this function must be called for every VectorData that is returned by any SQ function.

See also
SQ_VectorData
Parameters
[in]pVectorDataThe VectorData to be removed.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetColumnNames()

SQ_ErrorCode SQ_GetColumnNames ( SQ_VectorData  pVectorData,
SQ_StringVector pColumnNames 
)

Get the column names for the VectorData. DO NOT REMOVE this SQ_StringVector, it will be removed by SQ_ClearVectorData

See also
SQ_VectorData
Parameters
[in]pVectorDataThe VectorData to get the row names from.
[out]pColumnNamesThe names of the columns.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetDataMatrix()

SQ_ErrorCode SQ_GetDataMatrix ( SQ_VectorData  pVectorData,
SQ_FloatMatrix pMatrix 
)

Get the data matrix for the VectorData. DO NOT REMOVE this SQ_FloatMatrix, it will be removed by SQ_ClearVectorData

See also
SQ_VectorData
Parameters
[in]pVectorDataThe VectorData to get the matrix from.
[out]pMatrixThe data matrix.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetDataMatrixCopy()

SQ_ErrorCode SQ_GetDataMatrixCopy ( SQ_VectorData  pVectorData,
SQ_FloatMatrix pMatrix 
)

Get the data matrix for the VectorData. This is a copy of the matrix kept by vector data and must be manually removed using SQ_ClearStringMatrix.

See also
SQ_VectorData
Parameters
[in]pVectorDataThe VectorData to get the matrix from.
[out]pMatrixThe data matrix.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetRowAliases()

SQ_ErrorCode SQ_GetRowAliases ( SQ_VectorData  pVectorData,
SQ_StringVector pAliasNames 
)

Get the row alias names (the name of the primary and secondary IDs ) for the VectorData.

See also
SQ_VectorData pAliasNames should be freed with SQ_ClearStringVector
Parameters
[in]pVectorDataThe VectorData to get the row names from.
[out]pAliasNamesThe names of the primary and secondary ID's.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetRowNames()

SQ_ErrorCode SQ_GetRowNames ( SQ_VectorData  pVectorData,
SQ_StringVector pRowNames 
)

Get the row names for the VectorData. DO NOT REMOVE this SQ_StringVector, it will be removed by SQ_ClearVectorData

See also
SQ_VectorData
Parameters
[in]pVectorDataThe VectorData to get the row names from.
[out]pRowNamesThe names of the rows.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetRowNames2()

SQ_ErrorCode SQ_GetRowNames2 ( SQ_VectorData  pVectorData,
int  iAlias,
SQ_StringVector pRowNames 
)

Get the row names for the VectorData. pRowNames should be freed with SQ_ClearStringVector

See also
SQ_VectorData
Parameters
[in]pVectorDataThe VectorData to get the row names from.
[in]iAliasThe index of the ID to get, 1 is the primary alias and the same as calling SQ_GetRowNames.
[out]pRowNamesThe names of the rows.
Returns
Returns SQ_E_OK if success or an error code

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