#include "SQDef.h"
#include "SQErrorCodes.h"
#include "SQModel.h"
#include "SQDataset.h"
#include "SQCommon.h"
Go to the source code of this file.
Classes | |
struct | tagSQ_ProjectHandle |
Typedefs | |
typedef struct tagSQ_ProjectHandle * | SQ_Project |
This file list the SQ_Project object and all functions that can be performed on a project.
typedef struct tagSQ_ProjectHandle * SQ_Project |
The project handle used to identify an opened project. IMPORTANT: Always initialize it to NULL!
SQ_ErrorCode SQ_AreDatasetsRemoved | ( | SQ_Project | pProject, |
SQ_Bool * | pAreDatasetsRemoved | ||
) |
Check if the project is reduced, all results will not be available for reduced projects.
[in] | pProject | The project. |
[out] | pAreDatasetsRemoved | True if datasets are removed from the project |
SQ_ErrorCode SQ_AreResidualsRemoved | ( | SQ_Project | pProject, |
SQ_Bool * | pAreResidualsRemoved | ||
) |
Check if the project is reduced, all results will not be available for reduced projects.
[in] | pProject | The project. |
[out] | pAreResidualsRemoved | True if the model residuals are removed |
SQ_ErrorCode SQ_CloseProject | ( | SQ_Project * | pProject | ) |
Close an opened project. Every project that has been opened with OpenProject must be closed with this function.
[in] | pProject | The project to close. |
SQ_ErrorCode SQ_EnableEmbeddedScripts | ( | SQ_Project | pProject | ) |
Enable embedded python scripts, predictions will fail if the project contains embedded scripts and this is not called.
[in] | pProject | The project. |
SQ_ErrorCode SQ_GetDataset | ( | SQ_Project | pProject, |
int | iDatasetNumber, | ||
SQ_Dataset * | pDataset | ||
) |
Retrieves a dataset from the project. The datasets are closed automatically when the project is closed.
[in] | pProject | The project to get the dataset from. |
[in] | iDatasetNumber | The dataset number of the dataset (not dataset index). |
[out] | pDataset | The handle to the dataset. |
SQ_ErrorCode SQ_GetDatasetNumberFromIndex | ( | SQ_Project | pProject, |
int | iDatasetIndex, | ||
int * | piDatasetNumber | ||
) |
Retrieves the number of a data set given an index.
[in] | pProject | The project to use |
[in] | iDatasetIndex | The index of the project to get the number of. |
[out] | piDatasetNumber | The number of the data set. |
SQ_ErrorCode SQ_GetModel | ( | SQ_Project | pProject, |
int | iModelNumber, | ||
SQ_Model * | pModel | ||
) |
Retrieves a model from the project. The models are closed automatically when the parent project is closed.
[in] | pProject | The project to get the model from. |
[in] | iModelNumber | The model number of the model (not model index). |
[out] | pModel | The handle to the model |
SQ_ErrorCode SQ_GetModelInfo | ( | SQ_Project | pProject, |
int | iModelNumber, | ||
SQ_ModelInfo * | pModelInfo | ||
) |
Retrieves information about a model from the project.
[in] | pProject | The project to get the model from. |
[in] | iModelNumber | The model number of the model (not model index). |
[out] | pModelInfo | The struct to fill with model information |
SQ_ErrorCode SQ_GetModelNumberFromIndex | ( | SQ_Project | pProject, |
int | iModelIndex, | ||
int * | piModelNumber | ||
) |
Retrieves the model number from an index of a model.
[in] | pProject | The project to get the model number from |
[in] | iModelIndex | The index of the model to get the number of, between 1 and the result from GetNumberOfModels. |
[out] | piModelNumber | The model number. |
SQ_ErrorCode SQ_GetNumberOfDatasets | ( | SQ_Project | pProject, |
int * | pnNrOfDatasets | ||
) |
Retrieves the number of data sets in the project.
[in] | pProject | The project to use |
[out] | pnNrOfDatasets | The number of data sets in the project. |
SQ_ErrorCode SQ_GetNumberOfModels | ( | SQ_Project | pProject, |
int * | pnNrOfModels | ||
) |
Retrieves the number of models in the project, including unfitted models.
[in] | pProject | The project to get the number of models from |
[out] | pnNrOfModels | The total number of models in the project. |
SQ_ErrorCode SQ_GetProjectName | ( | SQ_Project | pProject, |
char * | pszProjectName, | ||
int | iLength | ||
) |
Retrieves the name of the project.
[in] | pProject | The project handle to get the name from. |
[in,out] | pszProjectName | A buffer to where the project name should be stored, UTF-8 encoded. The user is responsible for allocation/deallocation. |
[in] | iLength | The size of the buffer. |
SQ_ErrorCode SQ_IsProjectDirty | ( | SQ_Project | pProjHandle, |
SQ_Bool * | pbIsDirty | ||
) |
Checks if a project has data that has not been saved to disk
[in] | pProjHandle | The project handle to use |
[out] | pbIsDirty | Will be True if the project has data that has not been saved, otherwise False. |
SQ_ErrorCode SQ_IsProjectEncrypted | ( | const char * | szProjectName, |
SQ_Bool * | pIsEncrypted | ||
) |
Retrieves if the project is encrypted or not.
[in] | szProjectName | The full path to the SIMCA project file (.usp), UTF-8 encoded. |
[out] | pIsEncrypted | True if the project is encrypted, otherwise false. |
SQ_ErrorCode SQ_IsProjectReduced | ( | SQ_Project | pProject, |
SQ_Bool * | pIsReduced | ||
) |
Check if the project is reduced, all results will not be available for reduced projects.
[in] | pProject | The project. |
[out] | pIsReduced | True if the project is reduced |
SQ_ErrorCode SQ_IsReadOnly | ( | SQ_Project | pProject, |
SQ_Bool * | bIsReadOnly | ||
) |
Checks if the project is read-only.
[in] | pProject | The project to use |
[out] | bIsReadOnly | True if the project is read-only, False otherwise. |
SQ_ErrorCode SQ_OpenProject | ( | const char * | szProjectName, |
const char * | szPassword, | ||
SQ_Project * | pProject | ||
) |
Open an existing project (.usp). SIMCA-Q can handle multiple project that are identified with a project handle. It is the users responsibility to close the project when finished (SQ_CloseProject).
[in] | szProjectName | The full path to the SIMCA project file (.usp), UTF-8 encoded. |
[in] | szPassword | If the usp is encrypted, supply the password that was used to encrypt, UTF-8 encoded, else use NULL. |
[out] | pProject | The handle to this project. |
SQ_ErrorCode SQ_ProjectHasPythonScripts | ( | SQ_Project | pProject, |
SQ_Bool * | pIsHasScripts | ||
) |
Does the project contain embedded python scripts, predictions will fail if the project contains scripts and EnableEmbeddedScripts is not called.
[in] | pProject | The project. |
[out] | pIsHasScripts | True if the project contains embedded python scripts |
SQ_ErrorCode SQ_Save | ( | SQ_Project | pProjHandle | ) |
Save the project.
[in] | pProjHandle | The project handle to use |
Copyright (C) Sartorius Stedim Data Analytics AB - Generated by Doxygen