Go to the source code of this file.
Classes | |
struct | tagSQ_VectorData |
Typedefs | |
typedef struct tagSQ_VectorData * | SQ_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) |
This file list the SQ_VectorData object used in Umetrics SIMCA-Q products.
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!
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.
[in] | pVectorData | The VectorData to be removed. |
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
[in] | pVectorData | The VectorData to get the row names from. |
[out] | pColumnNames | The names of the columns. |
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
[in] | pVectorData | The VectorData to get the matrix from. |
[out] | pMatrix | The data matrix. |
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.
[in] | pVectorData | The VectorData to get the matrix from. |
[out] | pMatrix | The data matrix. |
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.
[in] | pVectorData | The VectorData to get the row names from. |
[out] | pAliasNames | The names of the primary and secondary ID's. |
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
[in] | pVectorData | The VectorData to get the row names from. |
[out] | pRowNames | The names of the rows. |
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
[in] | pVectorData | The VectorData to get the row names from. |
[in] | iAlias | The index of the ID to get, 1 is the primary alias and the same as calling SQ_GetRowNames. |
[out] | pRowNames | The names of the rows. |
Copyright (C) Sartorius Stedim Data Analytics AB - Generated by Doxygen