helics  2.8.1
helics.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2017-2021,
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 
8 #ifndef HELICS_APISHARED_FUNCTIONS_H_
9 #define HELICS_APISHARED_FUNCTIONS_H_
10 
11 #include "api-data.h"
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 #include "helics_export.h"
18 
19 #include <stdlib.h>
20 
26 /***************************************************
27  * Common Functions
28  ***************************************************/
29 
33 HELICS_EXPORT const char* helicsGetVersion(void);
34 
38 HELICS_EXPORT const char* helicsGetBuildFlags(void);
39 
43 HELICS_EXPORT const char* helicsGetCompilerVersion(void);
44 
48 HELICS_EXPORT helics_error helicsErrorInitialize(void);
49 
53 HELICS_EXPORT void helicsErrorClear(helics_error* err);
54 
57 HELICS_EXPORT void helicsLoadSignalHandler();
58 
60 HELICS_EXPORT void helicsClearSignalHandler();
61 
69 HELICS_EXPORT void helicsLoadSignalHandlerCallback(helics_bool (*handler)(int));
70 
73 HELICS_EXPORT void helicsAbort(int errorCode, const char* errorString);
74 
82 HELICS_EXPORT helics_bool helicsIsCoreTypeAvailable(const char* type);
83 
100 HELICS_EXPORT helics_core helicsCreateCore(const char* type, const char* name, const char* initString, helics_error* err);
101 
118 HELICS_EXPORT helics_core
119  helicsCreateCoreFromArgs(const char* type, const char* name, int argc, const char* const* argv, helics_error* err);
120 
133 HELICS_EXPORT helics_core helicsCoreClone(helics_core core, helics_error* err);
134 
140 HELICS_EXPORT helics_bool helicsCoreIsValid(helics_core core);
141 
159 HELICS_EXPORT helics_broker helicsCreateBroker(const char* type, const char* name, const char* initString, helics_error* err);
160 
176 HELICS_EXPORT helics_broker
177  helicsCreateBrokerFromArgs(const char* type, const char* name, int argc, const char* const* argv, helics_error* err);
178 
191 HELICS_EXPORT helics_broker helicsBrokerClone(helics_broker broker, helics_error* err);
192 
198 HELICS_EXPORT helics_bool helicsBrokerIsValid(helics_broker broker);
199 
208 
219 HELICS_EXPORT void helicsBrokerDataLink(helics_broker broker, const char* source, const char* target, helics_error* err);
220 
231 HELICS_EXPORT void helicsBrokerAddSourceFilterToEndpoint(helics_broker broker, const char* filter, const char* endpoint, helics_error* err);
232 
243 HELICS_EXPORT void
244  helicsBrokerAddDestinationFilterToEndpoint(helics_broker broker, const char* filter, const char* endpoint, helics_error* err);
245 
255 HELICS_EXPORT void helicsBrokerMakeConnections(helics_broker broker, const char* file, helics_error* err);
256 
268 HELICS_EXPORT helics_bool helicsCoreWaitForDisconnect(helics_core core, int msToWait, helics_error* err);
269 
281 HELICS_EXPORT helics_bool helicsBrokerWaitForDisconnect(helics_broker broker, int msToWait, helics_error* err);
282 
290 HELICS_EXPORT helics_bool helicsCoreIsConnected(helics_core core);
291 
302 HELICS_EXPORT void helicsCoreDataLink(helics_core core, const char* source, const char* target, helics_error* err);
303 
314 HELICS_EXPORT void helicsCoreAddSourceFilterToEndpoint(helics_core core, const char* filter, const char* endpoint, helics_error* err);
315 
326 HELICS_EXPORT void helicsCoreAddDestinationFilterToEndpoint(helics_core core, const char* filter, const char* endpoint, helics_error* err);
327 
337 HELICS_EXPORT void helicsCoreMakeConnections(helics_core core, const char* file, helics_error* err);
338 
346 HELICS_EXPORT const char* helicsBrokerGetIdentifier(helics_broker broker);
347 
355 HELICS_EXPORT const char* helicsCoreGetIdentifier(helics_core core);
356 
364 HELICS_EXPORT const char* helicsBrokerGetAddress(helics_broker broker);
365 
373 HELICS_EXPORT const char* helicsCoreGetAddress(helics_core core);
374 
386 HELICS_EXPORT void helicsCoreSetReadyToInit(helics_core core, helics_error* err);
387 
398 HELICS_EXPORT helics_bool helicsCoreConnect(helics_core core, helics_error* err);
399 
408 HELICS_EXPORT void helicsCoreDisconnect(helics_core core, helics_error* err);
409 
423 HELICS_EXPORT helics_federate helicsGetFederateByName(const char* fedName, helics_error* err);
424 
433 HELICS_EXPORT void helicsBrokerDisconnect(helics_broker broker, helics_error* err);
434 
438 HELICS_EXPORT void helicsFederateDestroy(helics_federate fed);
439 
443 HELICS_EXPORT void helicsBrokerDestroy(helics_broker broker);
444 
448 HELICS_EXPORT void helicsCoreDestroy(helics_core core);
449 
453 HELICS_EXPORT void helicsCoreFree(helics_core core);
454 
458 HELICS_EXPORT void helicsBrokerFree(helics_broker broker);
459 
460 /*
461  * Creation and destruction of Federates.
462  */
463 
477 HELICS_EXPORT helics_federate helicsCreateValueFederate(const char* fedName, helics_federate_info fi, helics_error* err);
478 
491 HELICS_EXPORT helics_federate helicsCreateValueFederateFromConfig(const char* configFile, helics_error* err);
492 
507 HELICS_EXPORT helics_federate helicsCreateMessageFederate(const char* fedName, helics_federate_info fi, helics_error* err);
508 
522 HELICS_EXPORT helics_federate helicsCreateMessageFederateFromConfig(const char* configFile, helics_error* err);
523 
538 HELICS_EXPORT helics_federate helicsCreateCombinationFederate(const char* fedName, helics_federate_info fi, helics_error* err);
539 
553 HELICS_EXPORT helics_federate helicsCreateCombinationFederateFromConfig(const char* configFile, helics_error* err);
554 
568 
575 
587 
598 HELICS_EXPORT void helicsFederateInfoLoadFromArgs(helics_federate_info fi, int argc, const char* const* argv, helics_error* err);
599 
603 HELICS_EXPORT void helicsFederateInfoFree(helics_federate_info fi);
604 
611 
621 HELICS_EXPORT void helicsFederateInfoSetCoreName(helics_federate_info fi, const char* corename, helics_error* err);
622 
632 HELICS_EXPORT void helicsFederateInfoSetCoreInitString(helics_federate_info fi, const char* coreInit, helics_error* err);
633 
643 HELICS_EXPORT void helicsFederateInfoSetBrokerInitString(helics_federate_info fi, const char* brokerInit, helics_error* err);
644 
655 HELICS_EXPORT void helicsFederateInfoSetCoreType(helics_federate_info fi, int coretype, helics_error* err);
656 
666 HELICS_EXPORT void helicsFederateInfoSetCoreTypeFromString(helics_federate_info fi, const char* coretype, helics_error* err);
667 
678 HELICS_EXPORT void helicsFederateInfoSetBroker(helics_federate_info fi, const char* broker, helics_error* err);
679 
690 HELICS_EXPORT void helicsFederateInfoSetBrokerKey(helics_federate_info fi, const char* brokerkey, helics_error* err);
691 
703 HELICS_EXPORT void helicsFederateInfoSetBrokerPort(helics_federate_info fi, int brokerPort, helics_error* err);
704 
715 HELICS_EXPORT void helicsFederateInfoSetLocalPort(helics_federate_info fi, const char* localPort, helics_error* err);
716 
723 HELICS_EXPORT int helicsGetPropertyIndex(const char* val);
724 
730 HELICS_EXPORT int helicsGetFlagIndex(const char* val);
731 
740 HELICS_EXPORT int helicsGetOptionIndex(const char* val);
741 
750 HELICS_EXPORT int helicsGetOptionValue(const char* val);
751 
763 HELICS_EXPORT void helicsFederateInfoSetFlagOption(helics_federate_info fi, int flag, helics_bool value, helics_error* err);
764 
776 HELICS_EXPORT void helicsFederateInfoSetSeparator(helics_federate_info fi, char separator, helics_error* err);
777 
788 HELICS_EXPORT void
789  helicsFederateInfoSetTimeProperty(helics_federate_info fi, int timeProperty, helics_time propertyValue, helics_error* err);
790 
791 // TODO(Dheepak): what are known properties. The docstring should reference all properties that can be passed here.
804 HELICS_EXPORT void helicsFederateInfoSetIntegerProperty(helics_federate_info fi, int intProperty, int propertyValue, helics_error* err);
805 
815 HELICS_EXPORT void helicsFederateRegisterInterfaces(helics_federate fed, const char* file, helics_error* err);
816 
826 HELICS_EXPORT void helicsFederateGlobalError(helics_federate fed, int errorCode, const char* errorString);
827 
837 HELICS_EXPORT void helicsFederateLocalError(helics_federate fed, int errorCode, const char* errorString);
838 
842 HELICS_EXPORT void helicsFederateFinalize(helics_federate fed, helics_error* err);
843 
848 
853 
858 HELICS_EXPORT void helicsFederateDisconnect(helics_federate fed, helics_error* err);
859 
864 
869 
873 HELICS_EXPORT void helicsFederateFree(helics_federate fed);
874 
879 HELICS_EXPORT void helicsCloseLibrary(void);
880 
881 /*
882  * Initialization, execution, and time requests.
883  */
884 
897 
909 
921 
931 
944 
957 
967 
983  helics_iteration_request iterate,
984  helics_error* err);
985 
999 
1011 
1023 
1035 
1048 
1061 
1076 
1099  helics_time requestTime,
1100  helics_iteration_request iterate,
1101  helics_iteration_result* outIteration,
1102  helics_error* err);
1103 
1115 HELICS_EXPORT void helicsFederateRequestTimeAsync(helics_federate fed, helics_time requestTime, helics_error* err);
1116 
1128 
1143  helics_time requestTime,
1144  helics_iteration_request iterate,
1145  helics_error* err);
1146 
1162  helics_iteration_result* outIterate,
1163  helics_error* err);
1164 
1172 HELICS_EXPORT const char* helicsFederateGetName(helics_federate fed);
1173 
1184 HELICS_EXPORT void helicsFederateSetTimeProperty(helics_federate fed, int timeProperty, helics_time time, helics_error* err);
1185 
1196 HELICS_EXPORT void helicsFederateSetFlagOption(helics_federate fed, int flag, helics_bool flagValue, helics_error* err);
1197 
1210 HELICS_EXPORT void helicsFederateSetSeparator(helics_federate fed, char separator, helics_error* err);
1211 
1222 HELICS_EXPORT void helicsFederateSetIntegerProperty(helics_federate fed, int intProperty, int propertyVal, helics_error* err);
1223 
1233 HELICS_EXPORT helics_time helicsFederateGetTimeProperty(helics_federate fed, int timeProperty, helics_error* err);
1234 
1247 
1259 HELICS_EXPORT int helicsFederateGetIntegerProperty(helics_federate fed, int intProperty, helics_error* err);
1260 
1272 
1284 HELICS_EXPORT void helicsFederateSetGlobal(helics_federate fed, const char* valueName, const char* value, helics_error* err);
1285 
1295 HELICS_EXPORT void helicsFederateAddDependency(helics_federate fed, const char* fedName, helics_error* err);
1296 
1306 HELICS_EXPORT void helicsFederateSetLogFile(helics_federate fed, const char* logFile, helics_error* err);
1307 
1317 HELICS_EXPORT void helicsFederateLogErrorMessage(helics_federate fed, const char* logmessage, helics_error* err);
1318 
1328 HELICS_EXPORT void helicsFederateLogWarningMessage(helics_federate fed, const char* logmessage, helics_error* err);
1329 
1339 HELICS_EXPORT void helicsFederateLogInfoMessage(helics_federate fed, const char* logmessage, helics_error* err);
1340 
1350 HELICS_EXPORT void helicsFederateLogDebugMessage(helics_federate fed, const char* logmessage, helics_error* err);
1351 
1362 HELICS_EXPORT void helicsFederateLogLevelMessage(helics_federate fed, int loglevel, const char* logmessage, helics_error* err);
1363 
1376 HELICS_EXPORT void helicsCoreSetGlobal(helics_core core, const char* valueName, const char* value, helics_error* err);
1377 
1390 HELICS_EXPORT void helicsBrokerSetGlobal(helics_broker broker, const char* valueName, const char* value, helics_error* err);
1391 
1401 HELICS_EXPORT void helicsCoreSetLogFile(helics_core core, const char* logFileName, helics_error* err);
1402 
1412 HELICS_EXPORT void helicsBrokerSetLogFile(helics_broker broker, const char* logFileName, helics_error* err);
1413 
1423 HELICS_EXPORT void helicsBrokerSetTimeBarrier(helics_broker broker, helics_time barrierTime, helics_error* err);
1424 
1430 HELICS_EXPORT void helicsBrokerClearTimeBarrier(helics_broker broker);
1431 
1442 HELICS_EXPORT void helicsBrokerGlobalError(helics_broker broker, int errorCode, const char* errorString, helics_error* err);
1443 
1454 HELICS_EXPORT void helicsCoreGlobalError(helics_core core, int errorCode, const char* errorString, helics_error* err);
1463 HELICS_EXPORT helics_query helicsCreateQuery(const char* target, const char* query);
1464 
1482 HELICS_EXPORT const char* helicsQueryExecute(helics_query query, helics_federate fed, helics_error* err);
1483 
1501 HELICS_EXPORT const char* helicsQueryCoreExecute(helics_query query, helics_core core, helics_error* err);
1502 
1520 HELICS_EXPORT const char* helicsQueryBrokerExecute(helics_query query, helics_broker broker, helics_error* err);
1521 
1531 HELICS_EXPORT void helicsQueryExecuteAsync(helics_query query, helics_federate fed, helics_error* err);
1532 
1549 HELICS_EXPORT const char* helicsQueryExecuteComplete(helics_query query, helics_error* err);
1550 
1561 HELICS_EXPORT helics_bool helicsQueryIsCompleted(helics_query query);
1562 
1573 HELICS_EXPORT void helicsQuerySetTarget(helics_query query, const char* target, helics_error* err);
1574 
1584 HELICS_EXPORT void helicsQuerySetQueryString(helics_query query, const char* queryString, helics_error* err);
1585 
1596 HELICS_EXPORT void helicsQuerySetOrdering(helics_query query, int32_t mode, helics_error* err);
1597 
1601 HELICS_EXPORT void helicsQueryFree(helics_query query);
1602 
1608 HELICS_EXPORT void helicsCleanupLibrary(void);
1609 
1610 #ifdef __cplusplus
1611 } /* end of extern "C" { */
1612 #endif
1613 
1614 #endif
helicsQueryFree
void helicsQueryFree(helics_query query)
Definition: helicsExport.cpp:1063
helicsBrokerSetTimeBarrier
void helicsBrokerSetTimeBarrier(helics_broker broker, helics_time barrierTime, helics_error *err)
Definition: helicsExport.cpp:529
helicsFederateInfoSetCoreName
void helicsFederateInfoSetCoreName(helics_federate_info fi, const char *corename, helics_error *err)
Definition: FederateExport.cpp:195
helicsFederateEnterExecutingModeIterative
helics_iteration_result helicsFederateEnterExecutingModeIterative(helics_federate fed, helics_iteration_request iterate, helics_error *err)
Definition: FederateExport.cpp:765
helicsCreateBrokerFromArgs
helics_broker helicsCreateBrokerFromArgs(const char *type, const char *name, int argc, const char *const *argv, helics_error *err)
Definition: helicsExport.cpp:412
helicsGetOptionIndex
int helicsGetOptionIndex(const char *val)
Definition: FederateExport.cpp:329
helicsFederateGetFlagOption
helics_bool helicsFederateGetFlagOption(helics_federate fed, int flag, helics_error *err)
Definition: FederateExport.cpp:1093
helicsQuerySetTarget
void helicsQuerySetTarget(helics_query query, const char *target, helics_error *err)
Definition: helicsExport.cpp:1036
helicsFederateGlobalError
void helicsFederateGlobalError(helics_federate fed, int errorCode, const char *errorString)
Definition: FederateExport.cpp:575
helicsFederateLogLevelMessage
void helicsFederateLogLevelMessage(helics_federate fed, int loglevel, const char *logmessage, helics_error *err)
Definition: FederateExport.cpp:1235
helicsFederateLogDebugMessage
void helicsFederateLogDebugMessage(helics_federate fed, const char *logmessage, helics_error *err)
Definition: FederateExport.cpp:1230
helicsCreateFederateInfo
helics_federate_info helicsCreateFederateInfo(void)
Definition: FederateExport.cpp:129
helicsFederateFinalizeComplete
void helicsFederateFinalizeComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:637
helicsQueryCoreExecute
const char * helicsQueryCoreExecute(helics_query query, helics_core core, helics_error *err)
Definition: helicsExport.cpp:937
helicsCreateMessageFederateFromConfig
helics_federate helicsCreateMessageFederateFromConfig(const char *configFile, helics_error *err)
Definition: FederateExport.cpp:454
helicsFederateLogWarningMessage
void helicsFederateLogWarningMessage(helics_federate fed, const char *logmessage, helics_error *err)
Definition: FederateExport.cpp:1220
helicsGetFlagIndex
int helicsGetFlagIndex(const char *val)
Definition: FederateExport.cpp:321
helicsCreateCoreFromArgs
helics_core helicsCreateCoreFromArgs(const char *type, const char *name, int argc, const char *const *argv, helics_error *err)
Definition: helicsExport.cpp:301
helicsCoreMakeConnections
void helicsCoreMakeConnections(helics_core core, const char *file, helics_error *err)
Definition: helicsExport.cpp:631
helicsFederateInfoSetFlagOption
void helicsFederateInfoSetFlagOption(helics_federate_info fi, int flag, helics_bool value, helics_error *err)
Definition: FederateExport.cpp:345
helicsFederateInfoClone
helics_federate_info helicsFederateInfoClone(helics_federate_info fi, helics_error *err)
Definition: FederateExport.cpp:155
helicsCoreConnect
helics_bool helicsCoreConnect(helics_core core, helics_error *err)
Definition: helicsExport.cpp:728
helicsCoreSetLogFile
void helicsCoreSetLogFile(helics_core core, const char *logFileName, helics_error *err)
Definition: helicsExport.cpp:667
helicsIsCoreTypeAvailable
helics_bool helicsIsCoreTypeAvailable(const char *type)
Definition: helicsExport.cpp:107
helicsFederateEnterExecutingModeAsync
void helicsFederateEnterExecutingModeAsync(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:781
helicsCloseLibrary
void helicsCloseLibrary(void)
Definition: helicsExport.cpp:866
helicsCreateValueFederate
helics_federate helicsCreateValueFederate(const char *fedName, helics_federate_info fi, helics_error *err)
Definition: FederateExport.cpp:382
helicsBrokerGlobalError
void helicsBrokerGlobalError(helics_broker broker, int errorCode, const char *errorString, helics_error *err)
Definition: helicsExport.cpp:547
helics_time
double helics_time
Definition: api-data.h:81
helics_core
void * helics_core
Definition: api-data.h:46
helics_query
void * helics_query
Definition: api-data.h:66
helicsCreateCombinationFederateFromConfig
helics_federate helicsCreateCombinationFederateFromConfig(const char *configFile, helics_error *err)
Definition: FederateExport.cpp:500
helicsQueryIsCompleted
helics_bool helicsQueryIsCompleted(helics_query query)
Definition: helicsExport.cpp:1023
helics_iteration_request
helics_iteration_request
Definition: api-data.h:100
helicsCreateCore
helics_core helicsCreateCore(const char *type, const char *name, const char *initString, helics_error *err)
Definition: helicsExport.cpp:266
helicsFederateEnterExecutingModeIterativeComplete
helics_iteration_result helicsFederateEnterExecutingModeIterativeComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:822
helicsFederateClone
helics_federate helicsFederateClone(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:519
helicsCoreWaitForDisconnect
helics_bool helicsCoreWaitForDisconnect(helics_core core, int msToWait, helics_error *err)
Definition: helicsExport.cpp:773
helicsBrokerMakeConnections
void helicsBrokerMakeConnections(helics_broker broker, const char *file, helics_error *err)
Definition: helicsExport.cpp:591
helicsFederateEnterInitializingMode
void helicsFederateEnterInitializingMode(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:669
helicsFederateSetSeparator
void helicsFederateSetSeparator(helics_federate fed, char separator, helics_error *err)
Definition: FederateExport.cpp:1128
helicsBrokerDisconnect
void helicsBrokerDisconnect(helics_broker broker, helics_error *err)
Definition: helicsExport.cpp:783
helicsQueryExecute
const char * helicsQueryExecute(helics_query query, helics_federate fed, helics_error *err)
Definition: helicsExport.cpp:917
helicsCoreIsValid
helics_bool helicsCoreIsValid(helics_core core)
Definition: helicsExport.cpp:351
helicsFederateGetTimeProperty
helics_time helicsFederateGetTimeProperty(helics_federate fed, int timeProperty, helics_error *err)
Definition: FederateExport.cpp:1074
helicsBrokerIsValid
helics_bool helicsBrokerIsValid(helics_broker broker)
Definition: helicsExport.cpp:459
helicsCleanupLibrary
void helicsCleanupLibrary(void)
Definition: helicsExport.cpp:1073
helicsFederateGetIntegerProperty
int helicsFederateGetIntegerProperty(helics_federate fed, int intProperty, helics_error *err)
Definition: FederateExport.cpp:1111
helicsBrokerGetIdentifier
const char * helicsBrokerGetIdentifier(helics_broker broker)
Definition: helicsExport.cpp:676
helicsCoreDisconnect
void helicsCoreDisconnect(helics_core core, helics_error *err)
Definition: helicsExport.cpp:746
helicsCoreGetAddress
const char * helicsCoreGetAddress(helics_core core)
Definition: helicsExport.cpp:708
helicsBrokerAddSourceFilterToEndpoint
void helicsBrokerAddSourceFilterToEndpoint(helics_broker broker, const char *filter, const char *endpoint, helics_error *err)
Definition: helicsExport.cpp:565
helicsBrokerSetGlobal
void helicsBrokerSetGlobal(helics_broker broker, const char *valueName, const char *value, helics_error *err)
Definition: helicsExport.cpp:507
helics_federate_state
helics_federate_state
Definition: api-data.h:119
helicsCreateValueFederateFromConfig
helics_federate helicsCreateValueFederateFromConfig(const char *configFile, helics_error *err)
Definition: FederateExport.cpp:409
helicsFederateIsValid
helics_bool helicsFederateIsValid(helics_federate fed)
Definition: FederateExport.cpp:535
helicsFederateInfoFree
void helicsFederateInfoFree(helics_federate_info fi)
Definition: FederateExport.cpp:165
helicsFederateSetFlagOption
void helicsFederateSetFlagOption(helics_federate fed, int flag, helics_bool flagValue, helics_error *err)
Definition: FederateExport.cpp:1042
helicsErrorInitialize
helics_error helicsErrorInitialize(void)
Definition: helicsExport.cpp:47
helicsCoreIsConnected
helics_bool helicsCoreIsConnected(helics_core core)
Definition: helicsExport.cpp:645
helicsCoreSetGlobal
void helicsCoreSetGlobal(helics_core core, const char *valueName, const char *value, helics_error *err)
Definition: helicsExport.cpp:654
helicsGetCompilerVersion
const char * helicsGetCompilerVersion(void)
Definition: helicsExport.cpp:38
helicsBrokerFree
void helicsBrokerFree(helics_broker broker)
Definition: helicsExport.cpp:827
helicsFederateInfoSetCoreType
void helicsFederateInfoSetCoreType(helics_federate_info fi, int coretype, helics_error *err)
Definition: FederateExport.cpp:237
helicsFederateGetName
const char * helicsFederateGetName(helics_federate fed)
Definition: FederateExport.cpp:1018
helicsGetVersion
const char * helicsGetVersion(void)
Definition: helicsExport.cpp:28
helicsCoreGlobalError
void helicsCoreGlobalError(helics_core core, int errorCode, const char *errorString, helics_error *err)
Definition: helicsExport.cpp:556
helicsCoreGetIdentifier
const char * helicsCoreGetIdentifier(helics_core core)
Definition: helicsExport.cpp:686
helicsFederateDestroy
void helicsFederateDestroy(helics_federate fed)
Definition: helicsExport.cpp:799
helicsLoadSignalHandler
void helicsLoadSignalHandler()
Definition: helicsExport.cpp:74
helicsFederateRequestTime
helics_time helicsFederateRequestTime(helics_federate fed, helics_time requestTime, helics_error *err)
Definition: FederateExport.cpp:838
helicsFederateEnterInitializingModeComplete
void helicsFederateEnterInitializingModeComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:706
helicsFederateInfoSetBrokerKey
void helicsFederateInfoSetBrokerKey(helics_federate_info fi, const char *brokerkey, helics_error *err)
Definition: FederateExport.cpp:281
helicsFederateRequestTimeIterative
helics_time helicsFederateRequestTimeIterative(helics_federate fed, helics_time requestTime, helics_iteration_request iterate, helics_iteration_result *outIteration, helics_error *err)
Definition: FederateExport.cpp:886
helicsFederateEnterInitializingModeAsync
void helicsFederateEnterInitializingModeAsync(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:683
helicsFederateAddDependency
void helicsFederateAddDependency(helics_federate fed, const char *fedName, helics_error *err)
Definition: FederateExport.cpp:1169
helicsBrokerAddDestinationFilterToEndpoint
void helicsBrokerAddDestinationFilterToEndpoint(helics_broker broker, const char *filter, const char *endpoint, helics_error *err)
Definition: helicsExport.cpp:578
helicsFederateSetIntegerProperty
void helicsFederateSetIntegerProperty(helics_federate fed, int intProperty, int propertyVal, helics_error *err)
Definition: FederateExport.cpp:1058
helicsQuerySetOrdering
void helicsQuerySetOrdering(helics_query query, int32_t mode, helics_error *err)
Definition: helicsExport.cpp:1054
fed
@ fed
special logging command for message coming from a fed
Definition: loggingHelper.hpp:32
helicsGetBuildFlags
const char * helicsGetBuildFlags(void)
Definition: helicsExport.cpp:33
helicsFederateFree
void helicsFederateFree(helics_federate fed)
Definition: helicsExport.cpp:837
helicsCoreAddDestinationFilterToEndpoint
void helicsCoreAddDestinationFilterToEndpoint(helics_core core, const char *filter, const char *endpoint, helics_error *err)
Definition: helicsExport.cpp:618
helicsClearSignalHandler
void helicsClearSignalHandler()
Definition: helicsExport.cpp:79
helicsBrokerSetLogFile
void helicsBrokerSetLogFile(helics_broker broker, const char *logFileName, helics_error *err)
Definition: helicsExport.cpp:520
helicsFederateDisconnectAsync
void helicsFederateDisconnectAsync(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:658
helicsFederateInfoSetBrokerInitString
void helicsFederateInfoSetBrokerInitString(helics_federate_info fi, const char *brokerInit, helics_error *err)
Definition: FederateExport.cpp:223
helicsQueryExecuteComplete
const char * helicsQueryExecuteComplete(helics_query query, helics_error *err)
Definition: helicsExport.cpp:1008
helicsGetFederateByName
helics_federate helicsGetFederateByName(const char *fedName, helics_error *err)
Definition: helicsExport.cpp:360
helicsFederateFinalize
void helicsFederateFinalize(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:605
helicsBrokerIsConnected
helics_bool helicsBrokerIsConnected(helics_broker broker)
Definition: helicsExport.cpp:468
helicsFederateGetCoreObject
helics_core helicsFederateGetCoreObject(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:541
helicsAbort
void helicsAbort(int errorCode, const char *errorString)
Definition: helicsExport.cpp:877
helicsFederateInfoSetBroker
void helicsFederateInfoSetBroker(helics_federate_info fi, const char *broker, helics_error *err)
Definition: FederateExport.cpp:267
helicsFederateInfoSetCoreTypeFromString
void helicsFederateInfoSetCoreTypeFromString(helics_federate_info fi, const char *coretype, helics_error *err)
Definition: FederateExport.cpp:246
helicsFederateInfoSetIntegerProperty
void helicsFederateInfoSetIntegerProperty(helics_federate_info fi, int intProperty, int propertyValue, helics_error *err)
Definition: FederateExport.cpp:372
helicsFederateRequestTimeAsync
void helicsFederateRequestTimeAsync(helics_federate fed, helics_time requestTime, helics_error *err)
Definition: FederateExport.cpp:915
helics_error
Definition: api-data.h:166
helicsFederateIsAsyncOperationCompleted
helics_bool helicsFederateIsAsyncOperationCompleted(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:697
helicsFederateSetGlobal
void helicsFederateSetGlobal(helics_federate fed, const char *valueName, const char *value, helics_error *err)
Definition: FederateExport.cpp:1148
helicsCoreDataLink
void helicsCoreDataLink(helics_core core, const char *source, const char *target, helics_error *err)
Definition: helicsExport.cpp:492
helicsFederateInfoSetCoreInitString
void helicsFederateInfoSetCoreInitString(helics_federate_info fi, const char *coreInit, helics_error *err)
Definition: FederateExport.cpp:209
helicsFederateGetCurrentTime
helics_time helicsFederateGetCurrentTime(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:1137
helicsFederateDisconnectComplete
void helicsFederateDisconnectComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:663
helicsFederateRegisterInterfaces
void helicsFederateRegisterInterfaces(helics_federate fed, const char *file, helics_error *err)
Definition: FederateExport.cpp:557
helicsCoreDestroy
void helicsCoreDestroy(helics_core core)
Definition: helicsExport.cpp:811
helicsFederateRequestTimeIterativeAsync
void helicsFederateRequestTimeIterativeAsync(helics_federate fed, helics_time requestTime, helics_iteration_request iterate, helics_error *err)
Definition: FederateExport.cpp:945
helicsFederateLocalError
void helicsFederateLocalError(helics_federate fed, int errorCode, const char *errorString)
Definition: FederateExport.cpp:590
helicsFederateInfoLoadFromArgs
void helicsFederateInfoLoadFromArgs(helics_federate_info fi, int argc, const char *const *argv, helics_error *err)
Definition: FederateExport.cpp:176
helicsQuerySetQueryString
void helicsQuerySetQueryString(helics_query query, const char *queryString, helics_error *err)
Definition: helicsExport.cpp:1045
helicsBrokerClearTimeBarrier
void helicsBrokerClearTimeBarrier(helics_broker broker)
Definition: helicsExport.cpp:538
helics_federate_info
void * helics_federate_info
Definition: api-data.h:61
helicsBrokerGetAddress
const char * helicsBrokerGetAddress(helics_broker broker)
Definition: helicsExport.cpp:697
helicsFederateRequestTimeAdvance
helics_time helicsFederateRequestTimeAdvance(helics_federate fed, helics_time timeDelta, helics_error *err)
Definition: FederateExport.cpp:854
helicsFederateRequestNextStep
helics_time helicsFederateRequestNextStep(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:870
helicsFederateInfoSetLocalPort
void helicsFederateInfoSetLocalPort(helics_federate_info fi, const char *localPort, helics_error *err)
Definition: FederateExport.cpp:304
helicsFederateInfoSetTimeProperty
void helicsFederateInfoSetTimeProperty(helics_federate_info fi, int timeProperty, helics_time propertyValue, helics_error *err)
Definition: FederateExport.cpp:354
helicsFederateLogInfoMessage
void helicsFederateLogInfoMessage(helics_federate fed, const char *logmessage, helics_error *err)
Definition: FederateExport.cpp:1225
helicsErrorClear
void helicsErrorClear(helics_error *err)
Definition: helicsExport.cpp:56
helicsLoadSignalHandlerCallback
void helicsLoadSignalHandlerCallback(helics_bool(*handler)(int))
Definition: helicsExport.cpp:97
helicsBrokerClone
helics_broker helicsBrokerClone(helics_broker broker, helics_error *err)
Definition: helicsExport.cpp:445
helicsCoreClone
helics_core helicsCoreClone(helics_core core, helics_error *err)
Definition: helicsExport.cpp:336
helicsFederateSetLogFile
void helicsFederateSetLogFile(helics_federate fed, const char *logFile, helics_error *err)
Definition: FederateExport.cpp:1190
api-data.h
Data structures for the C api.
helicsCoreFree
void helicsCoreFree(helics_core core)
Definition: helicsExport.cpp:817
helicsFederateSetTimeProperty
void helicsFederateSetTimeProperty(helics_federate fed, int timeProperty, helics_time time, helics_error *err)
Definition: FederateExport.cpp:1028
helics_broker
void * helics_broker
Definition: api-data.h:51
helicsBrokerDataLink
void helicsBrokerDataLink(helics_broker broker, const char *source, const char *target, helics_error *err)
Definition: helicsExport.cpp:479
helicsFederateLogErrorMessage
void helicsFederateLogErrorMessage(helics_federate fed, const char *logmessage, helics_error *err)
Definition: FederateExport.cpp:1215
helicsBrokerDestroy
void helicsBrokerDestroy(helics_broker broker)
Definition: helicsExport.cpp:805
helicsFederateFinalizeAsync
void helicsFederateFinalizeAsync(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:621
helicsCoreAddSourceFilterToEndpoint
void helicsCoreAddSourceFilterToEndpoint(helics_core core, const char *filter, const char *endpoint, helics_error *err)
Definition: helicsExport.cpp:605
helics_bool
int helics_bool
Definition: api-data.h:92
helicsQueryBrokerExecute
const char * helicsQueryBrokerExecute(helics_query query, helics_broker broker, helics_error *err)
Definition: helicsExport.cpp:959
helicsCreateBroker
helics_broker helicsCreateBroker(const char *type, const char *name, const char *initString, helics_error *err)
Definition: helicsExport.cpp:384
helicsFederateRequestTimeComplete
helics_time helicsFederateRequestTimeComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:929
helicsFederateGetState
helics_federate_state helicsFederateGetState(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:1000
helicsFederateEnterExecutingMode
void helicsFederateEnterExecutingMode(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:720
helicsFederateEnterExecutingModeComplete
void helicsFederateEnterExecutingModeComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:809
helicsFederateEnterExecutingModeIterativeAsync
void helicsFederateEnterExecutingModeIterativeAsync(helics_federate fed, helics_iteration_request iterate, helics_error *err)
Definition: FederateExport.cpp:795
helicsFederateInfoSetBrokerPort
void helicsFederateInfoSetBrokerPort(helics_federate_info fi, int brokerPort, helics_error *err)
Definition: FederateExport.cpp:295
helicsGetOptionValue
int helicsGetOptionValue(const char *val)
Definition: FederateExport.cpp:337
helicsGetPropertyIndex
int helicsGetPropertyIndex(const char *val)
Definition: FederateExport.cpp:313
helicsFederateInfoSetSeparator
void helicsFederateInfoSetSeparator(helics_federate_info fi, char separator, helics_error *err)
Definition: FederateExport.cpp:363
helicsCreateCombinationFederate
helics_federate helicsCreateCombinationFederate(const char *fedName, helics_federate_info fi, helics_error *err)
Definition: FederateExport.cpp:474
helicsCreateMessageFederate
helics_federate helicsCreateMessageFederate(const char *fedName, helics_federate_info fi, helics_error *err)
Definition: FederateExport.cpp:428
helicsCreateQuery
helics_query helicsCreateQuery(const char *target, const char *query)
Definition: helicsExport.cpp:906
helicsQueryExecuteAsync
void helicsQueryExecuteAsync(helics_query query, helics_federate fed, helics_error *err)
Definition: helicsExport.cpp:982
helicsBrokerWaitForDisconnect
helics_bool helicsBrokerWaitForDisconnect(helics_broker broker, int msToWait, helics_error *err)
Definition: helicsExport.cpp:763
helics_federate
void * helics_federate
Definition: api-data.h:56
helicsCoreSetReadyToInit
void helicsCoreSetReadyToInit(helics_core core, helics_error *err)
Definition: helicsExport.cpp:719
helics_iteration_result
helics_iteration_result
Definition: api-data.h:109
helicsFederateRequestTimeIterativeComplete
helics_time helicsFederateRequestTimeIterativeComplete(helics_federate fed, helics_iteration_result *outIterate, helics_error *err)
Definition: FederateExport.cpp:962
helicsFederateDisconnect
void helicsFederateDisconnect(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:653