| helics 3.6.1

helicsApps.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2017-2025,
3 Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC. See the top-level NOTICE for
4 additional details. All rights reserved.
5 SPDX-License-Identifier: BSD-3-Clause
6 */
7
13 #ifndef HELICS_APISHARED_APP_FUNCTIONS_H_
14 #define HELICS_APISHARED_APP_FUNCTIONS_H_
15
16 #include "helicsCore.h"
17
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21
23 HELICS_EXPORT HelicsBool helicsAppEnabled();
38 HELICS_EXPORT HelicsApp
39 helicsCreateApp(const char* appName, const char* appType, const char* configFile, HelicsFederateInfo fedInfo, HelicsError* err);
40
49 HELICS_EXPORT HelicsFederate helicsAppGetFederate(HelicsApp app, HelicsError* err);
50
60 HELICS_EXPORT void helicsAppLoadFile(HelicsApp app, const char* configFile, HelicsError* err);
61
67 HELICS_EXPORT void helicsAppInitialize(HelicsApp app, HelicsError* err);
68
74 HELICS_EXPORT void helicsAppRun(HelicsApp app, HelicsError* err);
75
82 HELICS_EXPORT void helicsAppRunTo(HelicsApp app, HelicsTime stopTime, HelicsError* err);
83
88 HELICS_EXPORT void helicsAppFinalize(HelicsApp app, HelicsError* err);
89
93 HELICS_EXPORT void helicsAppFree(HelicsApp app);
94
98 HELICS_EXPORT void helicsAppDestroy(HelicsApp app);
99
104 HELICS_EXPORT HelicsBool helicsAppIsActive(HelicsApp app);
105
106 #ifdef __cplusplus
107 } /* end of extern "C" { */
108 #endif
109
110 #endif
HelicsFederateInfo
void * HelicsFederateInfo
Definition: api-data.h:77
HelicsTime
double HelicsTime
Definition: api-data.h:106
HelicsApp
void * HelicsApp
Definition: api-data.h:71
HelicsBool
int HelicsBool
Definition: api-data.h:118
HelicsFederate
void * HelicsFederate
Definition: api-data.h:65
helicsAppFinalize
void helicsAppFinalize(HelicsApp app, HelicsError *err)
Definition: helicsAppsExport.cpp:219
helicsAppFree
void helicsAppFree(HelicsApp app)
Definition: helicsAppsExport.cpp:233
helicsCreateApp
HelicsApp helicsCreateApp(const char *appName, const char *appType, const char *configFile, HelicsFederateInfo fedInfo, HelicsError *err)
Definition: helicsAppsExport.cpp:99
helicsAppGetFederate
HelicsFederate helicsAppGetFederate(HelicsApp app, HelicsError *err)
Definition: helicsAppsExport.cpp:148
helicsAppIsActive
HelicsBool helicsAppIsActive(HelicsApp app)
Definition: helicsAppsExport.cpp:250
helicsAppInitialize
void helicsAppInitialize(HelicsApp app, HelicsError *err)
Definition: helicsAppsExport.cpp:177
helicsAppRun
void helicsAppRun(HelicsApp app, HelicsError *err)
Definition: helicsAppsExport.cpp:191
helicsAppEnabled
HelicsBool helicsAppEnabled()
Definition: helicsAppsExport.cpp:95
helicsAppDestroy
void helicsAppDestroy(HelicsApp app)
Definition: helicsAppsExport.cpp:244
helicsAppRunTo
void helicsAppRunTo(HelicsApp app, HelicsTime stopTime, HelicsError *err)
Definition: helicsAppsExport.cpp:205
helicsAppLoadFile
void helicsAppLoadFile(HelicsApp app, const char *configFile, HelicsError *err)
Definition: helicsAppsExport.cpp:163
helicsCore.h
Common functions for the HELICS C api.
HelicsError
Definition: api-data.h:177