Classes | Typedefs | Functions
SQProject.h File Reference
#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_ProjectHandleSQ_Project
 

Functions

SQ_ErrorCode SQ_OpenProject (const char *szProjectName, const char *szPassword, SQ_Project *pProject)
 
SQ_ErrorCode SQ_CloseProject (SQ_Project *pProject)
 
SQ_ErrorCode SQ_GetProjectName (SQ_Project pProject, char *pszProjectName, int iLength)
 
SQ_ErrorCode SQ_IsProjectEncrypted (const char *szProjectName, SQ_Bool *pIsEncrypted)
 
SQ_ErrorCode SQ_IsProjectReduced (SQ_Project pProject, SQ_Bool *pIsReduced)
 
SQ_ErrorCode SQ_AreDatasetsRemoved (SQ_Project pProject, SQ_Bool *pAreDatasetsRemoved)
 
SQ_ErrorCode SQ_AreResidualsRemoved (SQ_Project pProject, SQ_Bool *pAreResidualsRemoved)
 
SQ_ErrorCode SQ_ProjectHasPythonScripts (SQ_Project pProject, SQ_Bool *pIsHasScripts)
 
SQ_ErrorCode SQ_EnableEmbeddedScripts (SQ_Project pProject)
 
SQ_ErrorCode SQ_GetModel (SQ_Project pProject, int iModelNumber, SQ_Model *pModel)
 
SQ_ErrorCode SQ_GetModelInfo (SQ_Project pProject, int iModelNumber, SQ_ModelInfo *pModelInfo)
 
SQ_ErrorCode SQ_GetNumberOfModels (SQ_Project pProject, int *pnNrOfModels)
 
SQ_ErrorCode SQ_GetModelNumberFromIndex (SQ_Project pProject, int iModelIndex, int *piModelNumber)
 
SQ_ErrorCode SQ_GetDataset (SQ_Project pProject, int iDatasetNumber, SQ_Dataset *pDataset)
 
SQ_ErrorCode SQ_GetNumberOfDatasets (SQ_Project pProject, int *pnNrOfDatasets)
 
SQ_ErrorCode SQ_GetDatasetNumberFromIndex (SQ_Project pProject, int iDatasetIndex, int *piDatasetNumber)
 
SQ_ErrorCode SQ_IsReadOnly (SQ_Project pProject, SQ_Bool *bIsReadOnly)
 
SQ_ErrorCode SQ_Save (SQ_Project pProjHandle)
 
SQ_ErrorCode SQ_IsProjectDirty (SQ_Project pProjHandle, SQ_Bool *pbIsDirty)
 

Detailed Description

This file list the SQ_Project object and all functions that can be performed on a project.

Typedef Documentation

◆ SQ_Project

typedef struct tagSQ_ProjectHandle * SQ_Project

The project handle used to identify an opened project. IMPORTANT: Always initialize it to NULL!

Function Documentation

◆ SQ_AreDatasetsRemoved()

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.

See also
SQ_IsProjectReduced
Parameters
[in]pProjectThe project.
[out]pAreDatasetsRemovedTrue if datasets are removed from the project
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_AreResidualsRemoved()

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.

See also
SQ_IsProjectReduced
Parameters
[in]pProjectThe project.
[out]pAreResidualsRemovedTrue if the model residuals are removed
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_CloseProject()

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.

Parameters
[in]pProjectThe project to close.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_EnableEmbeddedScripts()

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.

Parameters
[in]pProjectThe project.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetDataset()

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.

Parameters
[in]pProjectThe project to get the dataset from.
[in]iDatasetNumberThe dataset number of the dataset (not dataset index).
[out]pDatasetThe handle to the dataset.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetDatasetNumberFromIndex()

SQ_ErrorCode SQ_GetDatasetNumberFromIndex ( SQ_Project  pProject,
int  iDatasetIndex,
int *  piDatasetNumber 
)

Retrieves the number of a data set given an index.

Parameters
[in]pProjectThe project to use
[in]iDatasetIndexThe index of the project to get the number of.
[out]piDatasetNumberThe number of the data set.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetModel()

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.

Parameters
[in]pProjectThe project to get the model from.
[in]iModelNumberThe model number of the model (not model index).
[out]pModelThe handle to the model
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetModelInfo()

SQ_ErrorCode SQ_GetModelInfo ( SQ_Project  pProject,
int  iModelNumber,
SQ_ModelInfo pModelInfo 
)

Retrieves information about a model from the project.

Parameters
[in]pProjectThe project to get the model from.
[in]iModelNumberThe model number of the model (not model index).
[out]pModelInfoThe struct to fill with model information
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetModelNumberFromIndex()

SQ_ErrorCode SQ_GetModelNumberFromIndex ( SQ_Project  pProject,
int  iModelIndex,
int *  piModelNumber 
)

Retrieves the model number from an index of a model.

Parameters
[in]pProjectThe project to get the model number from
[in]iModelIndexThe index of the model to get the number of, between 1 and the result from GetNumberOfModels.
[out]piModelNumberThe model number.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetNumberOfDatasets()

SQ_ErrorCode SQ_GetNumberOfDatasets ( SQ_Project  pProject,
int *  pnNrOfDatasets 
)

Retrieves the number of data sets in the project.

Parameters
[in]pProjectThe project to use
[out]pnNrOfDatasetsThe number of data sets in the project.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetNumberOfModels()

SQ_ErrorCode SQ_GetNumberOfModels ( SQ_Project  pProject,
int *  pnNrOfModels 
)

Retrieves the number of models in the project, including unfitted models.

See also
SQ_IsModelFitted.
Parameters
[in]pProjectThe project to get the number of models from
[out]pnNrOfModelsThe total number of models in the project.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetProjectName()

SQ_ErrorCode SQ_GetProjectName ( SQ_Project  pProject,
char *  pszProjectName,
int  iLength 
)

Retrieves the name of the project.

Parameters
[in]pProjectThe project handle to get the name from.
[in,out]pszProjectNameA buffer to where the project name should be stored, UTF-8 encoded. The user is responsible for allocation/deallocation.
[in]iLengthThe size of the buffer.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_IsProjectDirty()

SQ_ErrorCode SQ_IsProjectDirty ( SQ_Project  pProjHandle,
SQ_Bool pbIsDirty 
)

Checks if a project has data that has not been saved to disk

Parameters
[in]pProjHandleThe project handle to use
[out]pbIsDirtyWill be True if the project has data that has not been saved, otherwise False.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_IsProjectEncrypted()

SQ_ErrorCode SQ_IsProjectEncrypted ( const char *  szProjectName,
SQ_Bool pIsEncrypted 
)

Retrieves if the project is encrypted or not.

Parameters
[in]szProjectNameThe full path to the SIMCA project file (.usp), UTF-8 encoded.
[out]pIsEncryptedTrue if the project is encrypted, otherwise false.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_IsProjectReduced()

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.

See also
SQ_AreDatasetsRemoved and
SQ_AreResidualsRemoved
Parameters
[in]pProjectThe project.
[out]pIsReducedTrue if the project is reduced
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_IsReadOnly()

SQ_ErrorCode SQ_IsReadOnly ( SQ_Project  pProject,
SQ_Bool bIsReadOnly 
)

Checks if the project is read-only.

Parameters
[in]pProjectThe project to use
[out]bIsReadOnlyTrue if the project is read-only, False otherwise.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_OpenProject()

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).

Parameters
[in]szProjectNameThe full path to the SIMCA project file (.usp), UTF-8 encoded.
[in]szPasswordIf the usp is encrypted, supply the password that was used to encrypt, UTF-8 encoded, else use NULL.
[out]pProjectThe handle to this project.
See also
SQ_CloseProject
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_ProjectHasPythonScripts()

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.

Parameters
[in]pProjectThe project.
[out]pIsHasScriptsTrue if the project contains embedded python scripts
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_Save()

SQ_ErrorCode SQ_Save ( SQ_Project  pProjHandle)

Save the project.

Parameters
[in]pProjHandleThe project handle to use
Returns
Returns SQ_E_OK if success or an error code

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