Go to the source code of this file.
Classes | |
struct | tagSQ_StringMatrix |
Typedefs | |
typedef struct tagSQ_StringMatrix * | SQ_StringMatrix |
This file list the SQStringMatrix object used in Umetrics SIMCA-Q products.
typedef struct tagSQ_StringMatrix * SQ_StringMatrix |
A string matrix that is used to get and send strings to many functions. Index base = 1. IMPORTANT: Always initialize it to NULL!
SQ_ErrorCode SQ_ClearStringMatrix | ( | SQ_StringMatrix * | pMatrix | ) |
Removes the matrix, this function must be called for every matrix that has been initialized with SQ_InitStringMatrix.
[in] | pMatrix | The matrix to be removed. |
SQ_ErrorCode SQ_CopyStringMatrix | ( | SQ_StringMatrix | pInMatrix, |
SQ_StringMatrix * | pOutMatrix | ||
) |
Get a copy of the string matrix
[in] | pInMatrix | The matrix to copy. |
[in,out] | pOutMatrix | The result matrix. |
SQ_ErrorCode SQ_GetColumnStringsFromMatrix | ( | SQ_StringMatrix | pMatrix, |
int | iColumn, | ||
char *** | pszStrings | ||
) |
Gets the strings from a given column.
[in] | pMatrix | The matrix to get the strings from. |
[in] | iColumn | The column to get the strings from. |
[out] | pszStrings | The strings in the given column, UTF-8 encoded. |
SQ_ErrorCode SQ_GetNumColumnsInStringMatrix | ( | SQ_StringMatrix | pMatrix, |
int * | piNumCols | ||
) |
Returns the number of columns in the matrix.
[in] | pMatrix | The matrix to get the number of columns from. |
[out] | piNumCols | The number of columns in the matrix. |
SQ_ErrorCode SQ_GetNumRowsInStringMatrix | ( | SQ_StringMatrix | pMatrix, |
int * | piNumRows | ||
) |
Returns the number of rows in the matrix.
[in] | pMatrix | The matrix to get the number of rows from. |
[out] | piNumRows | The number of rows in the matrix. |
SQ_ErrorCode SQ_GetRowStringsFromMatrix | ( | SQ_StringMatrix | pMatrix, |
int | iRow, | ||
char *** | pszStrings | ||
) |
Gets the strings from a given row.
[in] | pMatrix | The matrix to get the strings from. |
[in] | iRow | The row to get the strings from. |
[out] | pszStrings | The strings in given row, UTF-8 encoded. |
SQ_ErrorCode SQ_GetStringFromMatrix | ( | SQ_StringMatrix | pMatrix, |
int | iRow, | ||
int | iColumn, | ||
char ** | pszString | ||
) |
Gets the string from a given cell.
[in] | pMatrix | The matrix to get the string from. |
[in] | iRow | The row to get the string from. |
[in] | iColumn | The column to get the string from. |
[out] | pszString | The string in the cell. A pointer to where the string should be stored, UTF-8 encoded. |
SQ_ErrorCode SQ_GetStringMatrix | ( | SQ_StringMatrix | pMatrix, |
char *** | pszStrings | ||
) |
Gets the strings from the matrix.
[in] | pMatrix | The matrix to get the strings from. |
[out] | pszStrings | A pointer to a matrix to be filled with strings from the StringMatrix, UTF-8 encoded. The format is Row 1, Row 2, etc. |
SQ_ErrorCode SQ_InitStringMatrix | ( | SQ_StringMatrix * | pMatrix, |
int | iRow, | ||
int | iColumn | ||
) |
Initialize a string matrix with its size.
[in] | pMatrix | The matrix to be initialized. |
[in] | iRow | Number of rows to give the matrix. |
[in] | iColumn | Number of columns to give the matrix. |
SQ_ErrorCode SQ_SetColumnStringsInMatrix | ( | SQ_StringMatrix | pMatrix, |
int | iColumn, | ||
const char ** | pszStrings | ||
) |
Sets the strings in the given column.
[in] | pMatrix | The matrix to set the strings in. |
[in] | iColumn | The column to set the strings in. |
[in] | pszStrings | An array of strings to set the column with. Must be of same length as number of rows, UTF-8 encoded. |
SQ_ErrorCode SQ_SetRowStringsInMatrix | ( | SQ_StringMatrix | pMatrix, |
int | iRow, | ||
const char ** | pszStrings | ||
) |
Sets the strings in the given row.
[in] | pMatrix | The matrix to set the strings in. |
[in] | iRow | The row to set the strings in. |
[in] | pszStrings | An array of strings to set the row with. Must be of same length as number of columns, UTF-8 encoded. |
SQ_ErrorCode SQ_SetStringInMatrix | ( | SQ_StringMatrix | pMatrix, |
int | iRow, | ||
int | iColumn, | ||
const char * | szString | ||
) |
Sets the string in the given cell.
[in] | pMatrix | The matrix to set the string in. |
[in] | iRow | The row to set the string in. |
[in] | iColumn | The column to set the string in. |
[in] | szString | The string to set the cell with, UTF-8 encoded. |
SQ_ErrorCode SQ_SetStringMatrix | ( | SQ_StringMatrix | pMatrix, |
const char *const * | pszStrings | ||
) |
Sets the strings in the matrix.
[in] | pMatrix | The matrix to set the strings in. |
[in] | pszStrings | A matrix of strings to fill the StringMatrix, UTF-8 encoded. Must be of same size as the StringMatrix. The format is Row 1, Row 2, etc. |
Copyright (C) Sartorius Stedim Data Analytics AB - Generated by Doxygen