SQProject.h
Go to the documentation of this file.
1 /*
2 Copyright (C) Sartorius Stedim Data Analytics AB 2017 -
3 */
4 #ifndef _SQPROJECT_H_
5 #define _SQPROJECT_H_
6 
7 #include "SQDef.h"
8 
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15 
16 #ifdef _WIN32
17 #pragma pack(push, 8)
18 #endif
19 
24  typedef struct tagSQ_ProjectHandle
25  {
27  void* reserved;
28  } *SQ_Project;
29 
30 #include "SQErrorCodes.h"
31 #include "SQModel.h"
32 #include "SQDataset.h"
33 #include "SQCommon.h"
34 
47  SQCEXPORT SQ_ErrorCode SQCDECL SQ_OpenProject(const char *szProjectName, const char *szPassword, SQ_Project *pProject);
48 
56  SQCEXPORT SQ_ErrorCode SQCDECL SQ_CloseProject(SQ_Project* pProject);
57 
67  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetProjectName(SQ_Project pProject, char* pszProjectName, int iLength);
68 
76  SQCEXPORT SQ_ErrorCode SQCDECL SQ_IsProjectEncrypted(const char *szProjectName, SQ_Bool* pIsEncrypted);
77 
86  SQCEXPORT SQ_ErrorCode SQCDECL SQ_IsProjectReduced(SQ_Project pProject, SQ_Bool* pIsReduced);
87 
96  SQCEXPORT SQ_ErrorCode SQCDECL SQ_AreDatasetsRemoved(SQ_Project pProject, SQ_Bool* pAreDatasetsRemoved);
97 
106  SQCEXPORT SQ_ErrorCode SQCDECL SQ_AreResidualsRemoved(SQ_Project pProject, SQ_Bool* pAreResidualsRemoved);
107 
108 
116  SQCEXPORT SQ_ErrorCode SQCDECL SQ_ProjectHasPythonScripts(SQ_Project pProject, SQ_Bool* pIsHasScripts);
117 
124  SQCEXPORT SQ_ErrorCode SQCDECL SQ_EnableEmbeddedScripts(SQ_Project pProject);
125 
135  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetModel(SQ_Project pProject, int iModelNumber, SQ_Model* pModel);
136 
146  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetModelInfo(SQ_Project pProject, int iModelNumber, SQ_ModelInfo* pModelInfo);
147 
155  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetNumberOfModels(SQ_Project pProject, int *pnNrOfModels);
156 
166  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetModelNumberFromIndex(SQ_Project pProject, int iModelIndex, int *piModelNumber);
167 
176  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDataset(SQ_Project pProject, int iDatasetNumber, SQ_Dataset* pDataset);
184  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetNumberOfDatasets(SQ_Project pProject, int *pnNrOfDatasets);
193  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDatasetNumberFromIndex(SQ_Project pProject, int iDatasetIndex, int *piDatasetNumber);
194 
202  SQCEXPORT SQ_ErrorCode SQCDECL SQ_IsReadOnly(SQ_Project pProject, SQ_Bool* bIsReadOnly);
203 
210  SQCEXPORT SQ_ErrorCode SQCDECL SQ_Save(SQ_Project pProjHandle);
211 
220  SQCEXPORT SQ_ErrorCode SQCDECL SQ_IsProjectDirty(SQ_Project pProjHandle, SQ_Bool *pbIsDirty);
221 
222 #ifdef _WIN32
223 #pragma pack(pop)
224 #endif
225 
226 #ifdef __cplusplus
227 }
228 #endif /*__cplusplus*/
229 
230 
231 #endif /* _SQPROJECT_H_ */
SQ_CloseProject
SQ_ErrorCode SQ_CloseProject(SQ_Project *pProject)
SQ_GetNumberOfModels
SQ_ErrorCode SQ_GetNumberOfModels(SQ_Project pProject, int *pnNrOfModels)
SQ_GetModel
SQ_ErrorCode SQ_GetModel(SQ_Project pProject, int iModelNumber, SQ_Model *pModel)
SQ_AreDatasetsRemoved
SQ_ErrorCode SQ_AreDatasetsRemoved(SQ_Project pProject, SQ_Bool *pAreDatasetsRemoved)
tagSQ_ProjectHandle
Definition: SQProject.h:24
tagSQ_Dataset
Definition: SQDataset.h:31
SQ_GetDataset
SQ_ErrorCode SQ_GetDataset(SQ_Project pProject, int iDatasetNumber, SQ_Dataset *pDataset)
SQ_Bool
enum SQ_BoolEnum SQ_Bool
SQCommon.h
tagSQ_ModelInfo
Definition: SQCommon.h:235
SQ_GetModelInfo
SQ_ErrorCode SQ_GetModelInfo(SQ_Project pProject, int iModelNumber, SQ_ModelInfo *pModelInfo)
SQ_GetProjectName
SQ_ErrorCode SQ_GetProjectName(SQ_Project pProject, char *pszProjectName, int iLength)
SQ_EnableEmbeddedScripts
SQ_ErrorCode SQ_EnableEmbeddedScripts(SQ_Project pProject)
SQDataset.h
SQ_IsProjectReduced
SQ_ErrorCode SQ_IsProjectReduced(SQ_Project pProject, SQ_Bool *pIsReduced)
SQ_Project
struct tagSQ_ProjectHandle * SQ_Project
SQ_Save
SQ_ErrorCode SQ_Save(SQ_Project pProjHandle)
SQ_OpenProject
SQ_ErrorCode SQ_OpenProject(const char *szProjectName, const char *szPassword, SQ_Project *pProject)
SQ_AreResidualsRemoved
SQ_ErrorCode SQ_AreResidualsRemoved(SQ_Project pProject, SQ_Bool *pAreResidualsRemoved)
SQ_GetDatasetNumberFromIndex
SQ_ErrorCode SQ_GetDatasetNumberFromIndex(SQ_Project pProject, int iDatasetIndex, int *piDatasetNumber)
SQ_ErrorCode
enum SQ_ErrorCodeEnum SQ_ErrorCode
SQ_GetModelNumberFromIndex
SQ_ErrorCode SQ_GetModelNumberFromIndex(SQ_Project pProject, int iModelIndex, int *piModelNumber)
SQ_IsProjectDirty
SQ_ErrorCode SQ_IsProjectDirty(SQ_Project pProjHandle, SQ_Bool *pbIsDirty)
SQ_ProjectHasPythonScripts
SQ_ErrorCode SQ_ProjectHasPythonScripts(SQ_Project pProject, SQ_Bool *pIsHasScripts)
SQ_IsProjectEncrypted
SQ_ErrorCode SQ_IsProjectEncrypted(const char *szProjectName, SQ_Bool *pIsEncrypted)
SQErrorCodes.h
SQ_GetNumberOfDatasets
SQ_ErrorCode SQ_GetNumberOfDatasets(SQ_Project pProject, int *pnNrOfDatasets)
tagSQ_ProjectHandle::reserved
void * reserved
Definition: SQProject.h:27
SQModel.h
tagSQ_ModelHandle
Definition: SQModel.h:24
SQ_IsReadOnly
SQ_ErrorCode SQ_IsReadOnly(SQ_Project pProject, SQ_Bool *bIsReadOnly)

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