helics  3.3.0
helicsCore.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2017-2022,
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 
50 HELICS_EXPORT const char* helicsGetSystemInfo(void);
51 
55 HELICS_EXPORT HelicsError helicsErrorInitialize(void);
56 
60 HELICS_EXPORT void helicsErrorClear(HelicsError* err);
61 
64 HELICS_EXPORT void helicsLoadSignalHandler();
65 
69 HELICS_EXPORT void helicsLoadThreadedSignalHandler();
70 
72 HELICS_EXPORT void helicsClearSignalHandler();
73 
82 HELICS_EXPORT void helicsLoadSignalHandlerCallback(HelicsBool (*handler)(int), HelicsBool useSeparateThread);
83 
92 HELICS_EXPORT void helicsLoadSignalHandlerCallbackNoExit(HelicsBool (*handler)(int), HelicsBool useSeparateThread);
93 
96 HELICS_EXPORT void helicsAbort(int errorCode, const char* errorString);
97 
105 HELICS_EXPORT HelicsBool helicsIsCoreTypeAvailable(const char* type);
106 
123 HELICS_EXPORT HelicsCore helicsCreateCore(const char* type, const char* name, const char* initString, HelicsError* err);
124 
141 HELICS_EXPORT HelicsCore helicsCreateCoreFromArgs(const char* type, const char* name, int argc, const char* const* argv, HelicsError* err);
142 
153 HELICS_EXPORT HelicsCore helicsCoreClone(HelicsCore core, HelicsError* err);
154 
160 HELICS_EXPORT HelicsBool helicsCoreIsValid(HelicsCore core);
161 
179 HELICS_EXPORT HelicsBroker helicsCreateBroker(const char* type, const char* name, const char* initString, HelicsError* err);
180 
194 HELICS_EXPORT HelicsBroker
195  helicsCreateBrokerFromArgs(const char* type, const char* name, int argc, const char* const* argv, HelicsError* err);
196 
209 HELICS_EXPORT HelicsBroker helicsBrokerClone(HelicsBroker broker, HelicsError* err);
210 
216 HELICS_EXPORT HelicsBool helicsBrokerIsValid(HelicsBroker broker);
217 
225 HELICS_EXPORT HelicsBool helicsBrokerIsConnected(HelicsBroker broker);
226 
237 HELICS_EXPORT void helicsBrokerDataLink(HelicsBroker broker, const char* source, const char* target, HelicsError* err);
238 
249 HELICS_EXPORT void helicsBrokerAddSourceFilterToEndpoint(HelicsBroker broker, const char* filter, const char* endpoint, HelicsError* err);
250 
261 HELICS_EXPORT void
262  helicsBrokerAddDestinationFilterToEndpoint(HelicsBroker broker, const char* filter, const char* endpoint, HelicsError* err);
263 
273 HELICS_EXPORT void helicsBrokerMakeConnections(HelicsBroker broker, const char* file, HelicsError* err);
274 
286 HELICS_EXPORT HelicsBool helicsCoreWaitForDisconnect(HelicsCore core, int msToWait, HelicsError* err);
287 
299 HELICS_EXPORT HelicsBool helicsBrokerWaitForDisconnect(HelicsBroker broker, int msToWait, HelicsError* err);
300 
308 HELICS_EXPORT HelicsBool helicsCoreIsConnected(HelicsCore core);
309 
320 HELICS_EXPORT void helicsCoreDataLink(HelicsCore core, const char* source, const char* target, HelicsError* err);
321 
332 HELICS_EXPORT void helicsCoreAddSourceFilterToEndpoint(HelicsCore core, const char* filter, const char* endpoint, HelicsError* err);
333 
344 HELICS_EXPORT void helicsCoreAddDestinationFilterToEndpoint(HelicsCore core, const char* filter, const char* endpoint, HelicsError* err);
345 
355 HELICS_EXPORT void helicsCoreMakeConnections(HelicsCore core, const char* file, HelicsError* err);
356 
364 HELICS_EXPORT const char* helicsBrokerGetIdentifier(HelicsBroker broker);
365 
373 HELICS_EXPORT const char* helicsCoreGetIdentifier(HelicsCore core);
374 
382 HELICS_EXPORT const char* helicsBrokerGetAddress(HelicsBroker broker);
383 
391 HELICS_EXPORT const char* helicsCoreGetAddress(HelicsCore core);
392 
404 HELICS_EXPORT void helicsCoreSetReadyToInit(HelicsCore core, HelicsError* err);
405 
416 HELICS_EXPORT HelicsBool helicsCoreConnect(HelicsCore core, HelicsError* err);
417 
426 HELICS_EXPORT void helicsCoreDisconnect(HelicsCore core, HelicsError* err);
427 
441 HELICS_EXPORT HelicsFederate helicsGetFederateByName(const char* fedName, HelicsError* err);
442 
451 HELICS_EXPORT void helicsBrokerDisconnect(HelicsBroker broker, HelicsError* err);
452 
456 HELICS_EXPORT void helicsFederateDestroy(HelicsFederate fed);
457 
461 HELICS_EXPORT void helicsBrokerDestroy(HelicsBroker broker);
462 
466 HELICS_EXPORT void helicsCoreDestroy(HelicsCore core);
467 
471 HELICS_EXPORT void helicsCoreFree(HelicsCore core);
472 
476 HELICS_EXPORT void helicsBrokerFree(HelicsBroker broker);
477 
478 /*
479  * Creation and destruction of Federates.
480  */
481 
495 HELICS_EXPORT HelicsFederate helicsCreateValueFederate(const char* fedName, HelicsFederateInfo fi, HelicsError* err);
496 
509 HELICS_EXPORT HelicsFederate helicsCreateValueFederateFromConfig(const char* configFile, HelicsError* err);
510 
525 HELICS_EXPORT HelicsFederate helicsCreateMessageFederate(const char* fedName, HelicsFederateInfo fi, HelicsError* err);
526 
540 HELICS_EXPORT HelicsFederate helicsCreateMessageFederateFromConfig(const char* configFile, HelicsError* err);
541 
556 HELICS_EXPORT HelicsFederate helicsCreateCombinationFederate(const char* fedName, HelicsFederateInfo fi, HelicsError* err);
557 
571 HELICS_EXPORT HelicsFederate helicsCreateCombinationFederateFromConfig(const char* configFile, HelicsError* err);
572 
586 
598 HELICS_EXPORT void helicsFederateProtect(const char* fedName, HelicsError* err);
599 
611 HELICS_EXPORT void helicsFederateUnProtect(const char* fedName, HelicsError* err);
612 
621 HELICS_EXPORT HelicsBool helicsFederateIsProtected(const char* fedName, HelicsError* err);
622 
628 HELICS_EXPORT HelicsFederateInfo helicsCreateFederateInfo(void);
629 
641 
652 HELICS_EXPORT void helicsFederateInfoLoadFromArgs(HelicsFederateInfo fi, int argc, const char* const* argv, HelicsError* err);
653 
663 HELICS_EXPORT void helicsFederateInfoLoadFromString(HelicsFederateInfo fi, const char* args, HelicsError* err);
664 
668 HELICS_EXPORT void helicsFederateInfoFree(HelicsFederateInfo fi);
669 
676 
686 HELICS_EXPORT void helicsFederateInfoSetCoreName(HelicsFederateInfo fi, const char* corename, HelicsError* err);
687 
697 HELICS_EXPORT void helicsFederateInfoSetCoreInitString(HelicsFederateInfo fi, const char* coreInit, HelicsError* err);
698 
708 HELICS_EXPORT void helicsFederateInfoSetBrokerInitString(HelicsFederateInfo fi, const char* brokerInit, HelicsError* err);
709 
720 HELICS_EXPORT void helicsFederateInfoSetCoreType(HelicsFederateInfo fi, int coretype, HelicsError* err);
721 
731 HELICS_EXPORT void helicsFederateInfoSetCoreTypeFromString(HelicsFederateInfo fi, const char* coretype, HelicsError* err);
732 
743 HELICS_EXPORT void helicsFederateInfoSetBroker(HelicsFederateInfo fi, const char* broker, HelicsError* err);
744 
755 HELICS_EXPORT void helicsFederateInfoSetBrokerKey(HelicsFederateInfo fi, const char* brokerkey, HelicsError* err);
756 
768 HELICS_EXPORT void helicsFederateInfoSetBrokerPort(HelicsFederateInfo fi, int brokerPort, HelicsError* err);
769 
780 HELICS_EXPORT void helicsFederateInfoSetLocalPort(HelicsFederateInfo fi, const char* localPort, HelicsError* err);
781 
788 HELICS_EXPORT int helicsGetPropertyIndex(const char* val);
789 
795 HELICS_EXPORT int helicsGetFlagIndex(const char* val);
796 
805 HELICS_EXPORT int helicsGetOptionIndex(const char* val);
806 
815 HELICS_EXPORT int helicsGetOptionValue(const char* val);
816 
825 HELICS_EXPORT int helicsGetDataType(const char* val);
826 
837 HELICS_EXPORT void helicsFederateInfoSetFlagOption(HelicsFederateInfo fi, int flag, HelicsBool value, HelicsError* err);
838 
849 HELICS_EXPORT void helicsFederateInfoSetSeparator(HelicsFederateInfo fi, char separator, HelicsError* err);
850 
860 HELICS_EXPORT void helicsFederateInfoSetTimeProperty(HelicsFederateInfo fi, int timeProperty, HelicsTime propertyValue, HelicsError* err);
861 
862 // TODO(Dheepak): what are known properties. The docstring should reference all properties that can be passed here.
874 HELICS_EXPORT void helicsFederateInfoSetIntegerProperty(HelicsFederateInfo fi, int intProperty, int propertyValue, HelicsError* err);
875 
884 HELICS_EXPORT void helicsFederateRegisterInterfaces(HelicsFederate fed, const char* file, HelicsError* err);
885 
896 HELICS_EXPORT void helicsFederateGlobalError(HelicsFederate fed, int errorCode, const char* errorString, HelicsError* err);
897 
908 HELICS_EXPORT void helicsFederateLocalError(HelicsFederate fed, int errorCode, const char* errorString, HelicsError* err);
909 
913 HELICS_EXPORT void helicsFederateFinalize(HelicsFederate fed, HelicsError* err);
914 
918 HELICS_EXPORT void helicsFederateFinalizeAsync(HelicsFederate fed, HelicsError* err);
919 
923 HELICS_EXPORT void helicsFederateFinalizeComplete(HelicsFederate fed, HelicsError* err);
924 
929 HELICS_EXPORT void helicsFederateDisconnect(HelicsFederate fed, HelicsError* err);
930 
934 HELICS_EXPORT void helicsFederateDisconnectAsync(HelicsFederate fed, HelicsError* err);
935 
939 HELICS_EXPORT void helicsFederateDisconnectComplete(HelicsFederate fed, HelicsError* err);
940 
944 HELICS_EXPORT void helicsFederateFree(HelicsFederate fed);
945 
950 HELICS_EXPORT void helicsCloseLibrary(void);
951 
952 /*
953  * Initialization, execution, and time requests.
954  */
955 
967 
978 
989 
998 
1009 HELICS_EXPORT void helicsFederateEnterExecutingMode(HelicsFederate fed, HelicsError* err);
1010 
1022 
1031 
1046  HelicsIterationRequest iterate,
1047  HelicsError* err);
1048 
1061 
1072 
1085 
1096 
1107 HELICS_EXPORT HelicsTime helicsFederateRequestTime(HelicsFederate fed, HelicsTime requestTime, HelicsError* err);
1108 
1120 
1134 
1152  HelicsTime requestTime,
1153  HelicsIterationRequest iterate,
1154  HelicsIterationResult* outIteration,
1155  HelicsError* err);
1156 
1167 HELICS_EXPORT void helicsFederateRequestTimeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsError* err);
1168 
1179 
1192 HELICS_EXPORT void
1194 
1206  HelicsIterationResult* outIterate,
1207  HelicsError* err);
1217 HELICS_EXPORT void helicsFederateProcessCommunications(HelicsFederate fed, HelicsTime period, HelicsError* err);
1218 
1226 HELICS_EXPORT const char* helicsFederateGetName(HelicsFederate fed);
1227 
1237 HELICS_EXPORT void helicsFederateSetTimeProperty(HelicsFederate fed, int timeProperty, HelicsTime time, HelicsError* err);
1238 
1248 HELICS_EXPORT void helicsFederateSetFlagOption(HelicsFederate fed, int flag, HelicsBool flagValue, HelicsError* err);
1249 
1261 HELICS_EXPORT void helicsFederateSetSeparator(HelicsFederate fed, char separator, HelicsError* err);
1262 
1272 HELICS_EXPORT void helicsFederateSetIntegerProperty(HelicsFederate fed, int intProperty, int propertyVal, HelicsError* err);
1273 
1282 HELICS_EXPORT HelicsTime helicsFederateGetTimeProperty(HelicsFederate fed, int timeProperty, HelicsError* err);
1283 
1294 HELICS_EXPORT HelicsBool helicsFederateGetFlagOption(HelicsFederate fed, int flag, HelicsError* err);
1295 
1306 HELICS_EXPORT int helicsFederateGetIntegerProperty(HelicsFederate fed, int intProperty, HelicsError* err);
1307 
1318 
1329 HELICS_EXPORT void helicsFederateSetGlobal(HelicsFederate fed, const char* valueName, const char* value, HelicsError* err);
1330 
1341 HELICS_EXPORT void helicsFederateSetTag(HelicsFederate fed, const char* tagName, const char* value, HelicsError* err);
1342 
1351 HELICS_EXPORT const char* helicsFederateGetTag(HelicsFederate fed, const char* tagName, HelicsError* err);
1352 
1361 HELICS_EXPORT void helicsFederateAddDependency(HelicsFederate fed, const char* fedName, HelicsError* err);
1362 
1371 HELICS_EXPORT void helicsFederateSetLogFile(HelicsFederate fed, const char* logFile, HelicsError* err);
1372 
1381 HELICS_EXPORT void helicsFederateLogErrorMessage(HelicsFederate fed, const char* logmessage, HelicsError* err);
1382 
1391 HELICS_EXPORT void helicsFederateLogWarningMessage(HelicsFederate fed, const char* logmessage, HelicsError* err);
1392 
1401 HELICS_EXPORT void helicsFederateLogInfoMessage(HelicsFederate fed, const char* logmessage, HelicsError* err);
1402 
1411 HELICS_EXPORT void helicsFederateLogDebugMessage(HelicsFederate fed, const char* logmessage, HelicsError* err);
1412 
1422 HELICS_EXPORT void helicsFederateLogLevelMessage(HelicsFederate fed, int loglevel, const char* logmessage, HelicsError* err);
1423 
1433 HELICS_EXPORT void helicsFederateSendCommand(HelicsFederate fed, const char* target, const char* command, HelicsError* err);
1434 
1444 HELICS_EXPORT const char* helicsFederateGetCommand(HelicsFederate fed, HelicsError* err);
1445 
1455 HELICS_EXPORT const char* helicsFederateGetCommandSource(HelicsFederate fed, HelicsError* err);
1456 
1466 HELICS_EXPORT const char* helicsFederateWaitCommand(HelicsFederate fed, HelicsError* err);
1478 HELICS_EXPORT void helicsCoreSetGlobal(HelicsCore core, const char* valueName, const char* value, HelicsError* err);
1479 
1491 HELICS_EXPORT void helicsBrokerSetGlobal(HelicsBroker broker, const char* valueName, const char* value, HelicsError* err);
1492 
1502 HELICS_EXPORT void helicsCoreSendCommand(HelicsCore core, const char* target, const char* command, HelicsError* err);
1503 
1513 HELICS_EXPORT void helicsCoreSendOrderedCommand(HelicsCore core, const char* target, const char* command, HelicsError* err);
1514 
1524 HELICS_EXPORT void helicsBrokerSendCommand(HelicsBroker broker, const char* target, const char* command, HelicsError* err);
1525 
1535 HELICS_EXPORT void helicsBrokerSendOrderedCommand(HelicsBroker broker, const char* target, const char* command, HelicsError* err);
1536 
1545 HELICS_EXPORT void helicsCoreSetLogFile(HelicsCore core, const char* logFileName, HelicsError* err);
1546 
1555 HELICS_EXPORT void helicsBrokerSetLogFile(HelicsBroker broker, const char* logFileName, HelicsError* err);
1556 
1565 HELICS_EXPORT void helicsBrokerSetTimeBarrier(HelicsBroker broker, HelicsTime barrierTime, HelicsError* err);
1566 
1572 HELICS_EXPORT void helicsBrokerClearTimeBarrier(HelicsBroker broker);
1573 
1583 HELICS_EXPORT void helicsBrokerGlobalError(HelicsBroker broker, int errorCode, const char* errorString, HelicsError* err);
1584 
1594 HELICS_EXPORT void helicsCoreGlobalError(HelicsCore core, int errorCode, const char* errorString, HelicsError* err);
1603 HELICS_EXPORT HelicsQuery helicsCreateQuery(const char* target, const char* query);
1604 
1620 HELICS_EXPORT const char* helicsQueryExecute(HelicsQuery query, HelicsFederate fed, HelicsError* err);
1621 
1636 HELICS_EXPORT const char* helicsQueryCoreExecute(HelicsQuery query, HelicsCore core, HelicsError* err);
1637 
1652 HELICS_EXPORT const char* helicsQueryBrokerExecute(HelicsQuery query, HelicsBroker broker, HelicsError* err);
1653 
1662 HELICS_EXPORT void helicsQueryExecuteAsync(HelicsQuery query, HelicsFederate fed, HelicsError* err);
1663 
1677 HELICS_EXPORT const char* helicsQueryExecuteComplete(HelicsQuery query, HelicsError* err);
1678 
1689 HELICS_EXPORT HelicsBool helicsQueryIsCompleted(HelicsQuery query);
1690 
1700 HELICS_EXPORT void helicsQuerySetTarget(HelicsQuery query, const char* target, HelicsError* err);
1701 
1710 HELICS_EXPORT void helicsQuerySetQueryString(HelicsQuery query, const char* queryString, HelicsError* err);
1711 
1721 HELICS_EXPORT void helicsQuerySetOrdering(HelicsQuery query, int32_t mode, HelicsError* err);
1722 
1726 HELICS_EXPORT void helicsQueryFree(HelicsQuery query);
1727 
1733 HELICS_EXPORT void helicsCleanupLibrary(void);
1734 
1735 #ifdef __cplusplus
1736 } /* end of extern "C" { */
1737 #endif
1738 
1739 #endif
helicsFederateInfoLoadFromArgs
void helicsFederateInfoLoadFromArgs(HelicsFederateInfo fi, int argc, const char *const *argv, HelicsError *err)
Definition: FederateExport.cpp:178
helicsFederateSetTag
void helicsFederateSetTag(HelicsFederate fed, const char *tagName, const char *value, HelicsError *err)
Definition: FederateExport.cpp:1352
helicsCoreSendCommand
void helicsCoreSendCommand(HelicsCore core, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:756
helicsFederateSetGlobal
void helicsFederateSetGlobal(HelicsFederate fed, const char *valueName, const char *value, HelicsError *err)
Definition: FederateExport.cpp:1331
helicsQuerySetTarget
void helicsQuerySetTarget(HelicsQuery query, const char *target, HelicsError *err)
Definition: helicsExport.cpp:1171
HelicsTime
double HelicsTime
Definition: api-data.h:100
helicsCoreClone
HelicsCore helicsCoreClone(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:431
helicsGetBuildFlags
const char * helicsGetBuildFlags(void)
Definition: helicsExport.cpp:36
helicsQueryCoreExecute
const char * helicsQueryCoreExecute(HelicsQuery query, HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:1053
helicsCoreFree
void helicsCoreFree(HelicsCore core)
Definition: helicsExport.cpp:924
helicsFederateSetFlagOption
void helicsFederateSetFlagOption(HelicsFederate fed, int flag, HelicsBool flagValue, HelicsError *err)
Definition: FederateExport.cpp:1225
helicsFederateGetCurrentTime
HelicsTime helicsFederateGetCurrentTime(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1320
helicsFederateInfoSetBroker
void helicsFederateInfoSetBroker(HelicsFederateInfo fi, const char *broker, HelicsError *err)
Definition: FederateExport.cpp:283
helicsCreateValueFederateFromConfig
HelicsFederate helicsCreateValueFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:447
helicsFederateRequestTimeComplete
HelicsTime helicsFederateRequestTimeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1043
helicsFederateRequestTimeAdvance
HelicsTime helicsFederateRequestTimeAdvance(HelicsFederate fed, HelicsTime timeDelta, HelicsError *err)
Definition: FederateExport.cpp:968
helicsFederateEnterExecutingModeAsync
void helicsFederateEnterExecutingModeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:895
helicsGetOptionValue
int helicsGetOptionValue(const char *val)
Definition: FederateExport.cpp:353
helicsQuerySetOrdering
void helicsQuerySetOrdering(HelicsQuery query, int32_t mode, HelicsError *err)
Definition: helicsExport.cpp:1189
helicsErrorClear
void helicsErrorClear(HelicsError *err)
Definition: helicsExport.cpp:66
helicsFederateDestroy
void helicsFederateDestroy(HelicsFederate fed)
Definition: helicsExport.cpp:906
helicsBrokerSetTimeBarrier
void helicsBrokerSetTimeBarrier(HelicsBroker broker, HelicsTime barrierTime, HelicsError *err)
Definition: helicsExport.cpp:618
helicsCoreDestroy
void helicsCoreDestroy(HelicsCore core)
Definition: helicsExport.cpp:918
helicsFederateIsValid
HelicsBool helicsFederateIsValid(HelicsFederate fed)
Definition: FederateExport.cpp:647
helicsFederateProcessCommunications
void helicsFederateProcessCommunications(HelicsFederate fed, HelicsTime period, HelicsError *err)
Definition: FederateExport.cpp:1098
helicsFederateEnterExecutingModeIterative
HelicsIterationResult helicsFederateEnterExecutingModeIterative(HelicsFederate fed, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:879
helicsFederateAddDependency
void helicsFederateAddDependency(HelicsFederate fed, const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:1395
helicsFederateEnterExecutingMode
void helicsFederateEnterExecutingMode(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:834
helicsBrokerClone
HelicsBroker helicsBrokerClone(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:516
helicsFederateEnterExecutingModeIterativeAsync
void helicsFederateEnterExecutingModeIterativeAsync(HelicsFederate fed, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:909
helicsFederateLocalError
void helicsFederateLocalError(HelicsFederate fed, int errorCode, const char *errorString, HelicsError *err)
Definition: FederateExport.cpp:703
helicsBrokerIsConnected
HelicsBool helicsBrokerIsConnected(HelicsBroker broker)
Definition: helicsExport.cpp:539
HelicsFederate
void * HelicsFederate
Definition: api-data.h:65
helicsFederateIsAsyncOperationCompleted
HelicsBool helicsFederateIsAsyncOperationCompleted(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:811
helicsLoadSignalHandlerCallbackNoExit
void helicsLoadSignalHandlerCallbackNoExit(HelicsBool(*handler)(int), HelicsBool useSeparateThread)
Definition: helicsExport.cpp:183
helicsQueryExecuteComplete
const char * helicsQueryExecuteComplete(HelicsQuery query, HelicsError *err)
Definition: helicsExport.cpp:1128
helicsFederateRegisterInterfaces
void helicsFederateRegisterInterfaces(HelicsFederate fed, const char *file, HelicsError *err)
Definition: FederateExport.cpp:669
helicsQueryExecuteAsync
void helicsQueryExecuteAsync(HelicsQuery query, HelicsFederate fed, HelicsError *err)
Definition: helicsExport.cpp:1101
helicsCoreSetGlobal
void helicsCoreSetGlobal(HelicsCore core, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:743
helicsCreateMessageFederateFromConfig
HelicsFederate helicsCreateMessageFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:492
helicsFederateFinalize
void helicsFederateFinalize(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:719
helicsCreateCombinationFederateFromConfig
HelicsFederate helicsCreateCombinationFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:538
helicsGetOptionIndex
int helicsGetOptionIndex(const char *val)
Definition: FederateExport.cpp:345
helicsFederateSendCommand
void helicsFederateSendCommand(HelicsFederate fed, const char *target, const char *command, HelicsError *err)
Definition: FederateExport.cpp:1470
helicsFederateSetSeparator
void helicsFederateSetSeparator(HelicsFederate fed, char separator, HelicsError *err)
Definition: FederateExport.cpp:1311
helicsCoreDataLink
void helicsCoreDataLink(HelicsCore core, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:563
helicsQueryExecute
const char * helicsQueryExecute(HelicsQuery query, HelicsFederate fed, HelicsError *err)
Definition: helicsExport.cpp:1025
helicsFederateClone
HelicsFederate helicsFederateClone(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:557
helicsCreateCore
HelicsCore helicsCreateCore(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:361
helicsFederateEnterExecutingModeComplete
void helicsFederateEnterExecutingModeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:923
helicsQueryFree
void helicsQueryFree(HelicsQuery query)
Definition: helicsExport.cpp:1198
helicsFederateGlobalError
void helicsFederateGlobalError(HelicsFederate fed, int errorCode, const char *errorString, HelicsError *err)
Definition: FederateExport.cpp:687
helicsFederateLogWarningMessage
void helicsFederateLogWarningMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1446
helicsIsCoreTypeAvailable
HelicsBool helicsIsCoreTypeAvailable(const char *type)
Definition: helicsExport.cpp:202
helicsBrokerSendCommand
void helicsBrokerSendCommand(HelicsBroker broker, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:591
helicsFederateGetState
HelicsFederateState helicsFederateGetState(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1117
helicsCoreGetIdentifier
const char * helicsCoreGetIdentifier(HelicsCore core)
Definition: helicsExport.cpp:793
helicsFederateGetCommand
const char * helicsFederateGetCommand(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1479
helicsFederateRequestTime
HelicsTime helicsFederateRequestTime(HelicsFederate fed, HelicsTime requestTime, HelicsError *err)
Definition: FederateExport.cpp:952
helicsFederateSetIntegerProperty
void helicsFederateSetIntegerProperty(HelicsFederate fed, int intProperty, int propertyVal, HelicsError *err)
Definition: FederateExport.cpp:1241
helicsBrokerFree
void helicsBrokerFree(HelicsBroker broker)
Definition: helicsExport.cpp:934
helicsBrokerGetIdentifier
const char * helicsBrokerGetIdentifier(HelicsBroker broker)
Definition: helicsExport.cpp:783
helicsFederateDisconnectAsync
void helicsFederateDisconnectAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:750
helicsBrokerDisconnect
void helicsBrokerDisconnect(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:890
helicsFederateProtect
void helicsFederateProtect(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:604
helicsFederateSetTimeProperty
void helicsFederateSetTimeProperty(HelicsFederate fed, int timeProperty, HelicsTime time, HelicsError *err)
Definition: FederateExport.cpp:1211
helicsCreateCoreFromArgs
HelicsCore helicsCreateCoreFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:396
helicsErrorInitialize
HelicsError helicsErrorInitialize(void)
Definition: helicsExport.cpp:57
helicsFederateInfoSetTimeProperty
void helicsFederateInfoSetTimeProperty(HelicsFederateInfo fi, int timeProperty, HelicsTime propertyValue, HelicsError *err)
Definition: FederateExport.cpp:392
helicsBrokerClearTimeBarrier
void helicsBrokerClearTimeBarrier(HelicsBroker broker)
Definition: helicsExport.cpp:627
helicsGetCompilerVersion
const char * helicsGetCompilerVersion(void)
Definition: helicsExport.cpp:41
helicsFederateRequestNextStep
HelicsTime helicsFederateRequestNextStep(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:984
helicsCreateFederateInfo
HelicsFederateInfo helicsCreateFederateInfo(void)
Definition: FederateExport.cpp:131
helicsFederateSetLogFile
void helicsFederateSetLogFile(HelicsFederate fed, const char *logFile, HelicsError *err)
Definition: FederateExport.cpp:1416
HelicsFederateInfo
void * HelicsFederateInfo
Definition: api-data.h:71
helicsCloseLibrary
void helicsCloseLibrary(void)
Definition: helicsExport.cpp:973
helicsFederateGetName
const char * helicsFederateGetName(HelicsFederate fed)
Definition: FederateExport.cpp:1201
helicsFederateUnProtect
void helicsFederateUnProtect(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:615
helicsCreateMessageFederate
HelicsFederate helicsCreateMessageFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:466
HelicsBroker
void * HelicsBroker
Definition: api-data.h:60
helicsCoreGlobalError
void helicsCoreGlobalError(HelicsCore core, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:645
helicsQueryIsCompleted
HelicsBool helicsQueryIsCompleted(HelicsQuery query)
Definition: helicsExport.cpp:1151
helicsFederateInfoFree
void helicsFederateInfoFree(HelicsFederateInfo fi)
Definition: FederateExport.cpp:167
helicsCleanupLibrary
void helicsCleanupLibrary(void)
Definition: helicsExport.cpp:1209
helicsFederateInfoSetFlagOption
void helicsFederateInfoSetFlagOption(HelicsFederateInfo fi, int flag, HelicsBool value, HelicsError *err)
Definition: FederateExport.cpp:369
helicsFederateEnterInitializingModeAsync
void helicsFederateEnterInitializingModeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:797
helicsCreateBrokerFromArgs
HelicsBroker helicsCreateBrokerFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:483
helicsFederateInfoSetCoreInitString
void helicsFederateInfoSetCoreInitString(HelicsFederateInfo fi, const char *coreInit, HelicsError *err)
Definition: FederateExport.cpp:225
helicsFederateInfoSetCoreName
void helicsFederateInfoSetCoreName(HelicsFederateInfo fi, const char *corename, HelicsError *err)
Definition: FederateExport.cpp:211
helicsFederateGetIntegerProperty
int helicsFederateGetIntegerProperty(HelicsFederate fed, int intProperty, HelicsError *err)
Definition: FederateExport.cpp:1294
helicsFederateRequestTimeIterative
HelicsTime helicsFederateRequestTimeIterative(HelicsFederate fed, HelicsTime requestTime, HelicsIterationRequest iterate, HelicsIterationResult *outIteration, HelicsError *err)
Definition: FederateExport.cpp:1000
helicsGetSystemInfo
const char * helicsGetSystemInfo(void)
Definition: helicsExport.cpp:46
helicsGetFlagIndex
int helicsGetFlagIndex(const char *val)
Definition: FederateExport.cpp:337
helicsFederateLogDebugMessage
void helicsFederateLogDebugMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1456
helicsCoreDisconnect
void helicsCoreDisconnect(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:853
helicsFederateLogInfoMessage
void helicsFederateLogInfoMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1451
helicsBrokerSendOrderedCommand
void helicsBrokerSendOrderedCommand(HelicsBroker broker, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:600
helicsFederateLogLevelMessage
void helicsFederateLogLevelMessage(HelicsFederate fed, int loglevel, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1461
helicsCoreConnect
HelicsBool helicsCoreConnect(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:835
helicsFederateInfoSetCoreTypeFromString
void helicsFederateInfoSetCoreTypeFromString(HelicsFederateInfo fi, const char *coretype, HelicsError *err)
Definition: FederateExport.cpp:262
helicsFederateGetCommandSource
const char * helicsFederateGetCommandSource(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1494
helicsFederateInfoSetLocalPort
void helicsFederateInfoSetLocalPort(HelicsFederateInfo fi, const char *localPort, HelicsError *err)
Definition: FederateExport.cpp:320
helicsFederateInfoLoadFromString
void helicsFederateInfoLoadFromString(HelicsFederateInfo fi, const char *args, HelicsError *err)
Definition: FederateExport.cpp:197
helicsFederateFinalizeComplete
void helicsFederateFinalizeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:729
helicsFederateDisconnect
void helicsFederateDisconnect(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:734
helicsBrokerIsValid
HelicsBool helicsBrokerIsValid(HelicsBroker broker)
Definition: helicsExport.cpp:530
helicsFederateGetTag
const char * helicsFederateGetTag(HelicsFederate fed, const char *tagName, HelicsError *err)
Definition: FederateExport.cpp:1372
helicsQuerySetQueryString
void helicsQuerySetQueryString(HelicsQuery query, const char *queryString, HelicsError *err)
Definition: helicsExport.cpp:1180
helicsBrokerMakeConnections
void helicsBrokerMakeConnections(HelicsBroker broker, const char *file, HelicsError *err)
Definition: helicsExport.cpp:680
HelicsFederateState
HelicsFederateState
Definition: api-data.h:139
helicsCreateBroker
HelicsBroker helicsCreateBroker(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:455
helicsBrokerAddDestinationFilterToEndpoint
void helicsBrokerAddDestinationFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:667
HelicsError
Definition: api-data.h:169
HelicsIterationResult
HelicsIterationResult
Definition: api-data.h:129
helicsCreateCombinationFederate
HelicsFederate helicsCreateCombinationFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:512
helicsClearSignalHandler
void helicsClearSignalHandler()
Definition: helicsExport.cpp:113
helicsBrokerSetLogFile
void helicsBrokerSetLogFile(HelicsBroker broker, const char *logFileName, HelicsError *err)
Definition: helicsExport.cpp:609
helicsFederateGetFlagOption
HelicsBool helicsFederateGetFlagOption(HelicsFederate fed, int flag, HelicsError *err)
Definition: FederateExport.cpp:1276
helicsLoadSignalHandlerCallback
void helicsLoadSignalHandlerCallback(HelicsBool(*handler)(int), HelicsBool useSeparateThread)
Definition: helicsExport.cpp:164
helicsCoreAddSourceFilterToEndpoint
void helicsCoreAddSourceFilterToEndpoint(HelicsCore core, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:694
helicsFederateIsProtected
HelicsBool helicsFederateIsProtected(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:630
helicsAbort
void helicsAbort(int errorCode, const char *errorString)
Definition: helicsExport.cpp:983
HelicsCore
void * HelicsCore
Definition: api-data.h:54
helicsCoreSendOrderedCommand
void helicsCoreSendOrderedCommand(HelicsCore core, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:765
helicsQueryBrokerExecute
const char * helicsQueryBrokerExecute(HelicsQuery query, HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:1076
helicsCoreSetReadyToInit
void helicsCoreSetReadyToInit(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:826
helicsFederateRequestTimeIterativeComplete
HelicsTime helicsFederateRequestTimeIterativeComplete(HelicsFederate fed, HelicsIterationResult *outIterate, HelicsError *err)
Definition: FederateExport.cpp:1073
helicsGetVersion
const char * helicsGetVersion(void)
Definition: helicsExport.cpp:31
helicsFederateFinalizeAsync
void helicsFederateFinalizeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:724
helicsFederateInfoSetBrokerKey
void helicsFederateInfoSetBrokerKey(HelicsFederateInfo fi, const char *brokerkey, HelicsError *err)
Definition: FederateExport.cpp:297
helicsFederateFree
void helicsFederateFree(HelicsFederate fed)
Definition: helicsExport.cpp:944
helicsBrokerAddSourceFilterToEndpoint
void helicsBrokerAddSourceFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:654
helicsFederateRequestTimeAsync
void helicsFederateRequestTimeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsError *err)
Definition: FederateExport.cpp:1029
helicsFederateInfoSetBrokerInitString
void helicsFederateInfoSetBrokerInitString(HelicsFederateInfo fi, const char *brokerInit, HelicsError *err)
Definition: FederateExport.cpp:239
helicsFederateEnterInitializingMode
void helicsFederateEnterInitializingMode(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:783
api-data.h
Data structures for the C api.
helicsCoreAddDestinationFilterToEndpoint
void helicsCoreAddDestinationFilterToEndpoint(HelicsCore core, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:707
helicsFederateGetTimeProperty
HelicsTime helicsFederateGetTimeProperty(HelicsFederate fed, int timeProperty, HelicsError *err)
Definition: FederateExport.cpp:1257
helicsBrokerWaitForDisconnect
HelicsBool helicsBrokerWaitForDisconnect(HelicsBroker broker, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:870
helicsGetDataType
int helicsGetDataType(const char *val)
Definition: FederateExport.cpp:361
helicsFederateInfoSetIntegerProperty
void helicsFederateInfoSetIntegerProperty(HelicsFederateInfo fi, int intProperty, int propertyValue, HelicsError *err)
Definition: FederateExport.cpp:410
helicsCreateQuery
HelicsQuery helicsCreateQuery(const char *target, const char *query)
Definition: helicsExport.cpp:1012
helicsFederateEnterInitializingModeComplete
void helicsFederateEnterInitializingModeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:820
helicsCreateValueFederate
HelicsFederate helicsCreateValueFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:420
helicsBrokerSetGlobal
void helicsBrokerSetGlobal(HelicsBroker broker, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:578
helicsBrokerGlobalError
void helicsBrokerGlobalError(HelicsBroker broker, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:636
helicsFederateLogErrorMessage
void helicsFederateLogErrorMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1441
helicsLoadSignalHandler
void helicsLoadSignalHandler()
Definition: helicsExport.cpp:103
helicsFederateWaitCommand
const char * helicsFederateWaitCommand(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1504
HelicsQuery
void * HelicsQuery
Definition: api-data.h:77
helicsCoreIsConnected
HelicsBool helicsCoreIsConnected(HelicsCore core)
Definition: helicsExport.cpp:734
helicsFederateInfoSetBrokerPort
void helicsFederateInfoSetBrokerPort(HelicsFederateInfo fi, int brokerPort, HelicsError *err)
Definition: FederateExport.cpp:311
helicsBrokerGetAddress
const char * helicsBrokerGetAddress(HelicsBroker broker)
Definition: helicsExport.cpp:804
helicsGetPropertyIndex
int helicsGetPropertyIndex(const char *val)
Definition: FederateExport.cpp:329
helicsFederateInfoClone
HelicsFederateInfo helicsFederateInfoClone(HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:157
helicsLoadThreadedSignalHandler
void helicsLoadThreadedSignalHandler()
Definition: helicsExport.cpp:108
helicsFederateEnterExecutingModeIterativeComplete
HelicsIterationResult helicsFederateEnterExecutingModeIterativeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:936
helicsFederateInfoSetSeparator
void helicsFederateInfoSetSeparator(HelicsFederateInfo fi, char separator, HelicsError *err)
Definition: FederateExport.cpp:401
helicsCoreGetAddress
const char * helicsCoreGetAddress(HelicsCore core)
Definition: helicsExport.cpp:815
helicsCoreMakeConnections
void helicsCoreMakeConnections(HelicsCore core, const char *file, HelicsError *err)
Definition: helicsExport.cpp:720
helicsCoreIsValid
HelicsBool helicsCoreIsValid(HelicsCore core)
Definition: helicsExport.cpp:446
helicsFederateGetCore
HelicsCore helicsFederateGetCore(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:653
helicsCoreSetLogFile
void helicsCoreSetLogFile(HelicsCore core, const char *logFileName, HelicsError *err)
Definition: helicsExport.cpp:774
helicsGetFederateByName
HelicsFederate helicsGetFederateByName(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:573
helicsCoreWaitForDisconnect
HelicsBool helicsCoreWaitForDisconnect(HelicsCore core, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:880
helicsBrokerDestroy
void helicsBrokerDestroy(HelicsBroker broker)
Definition: helicsExport.cpp:912
HelicsBool
int HelicsBool
Definition: api-data.h:112
HelicsIterationRequest
HelicsIterationRequest
Definition: api-data.h:120
helicsFederateInfoSetCoreType
void helicsFederateInfoSetCoreType(HelicsFederateInfo fi, int coretype, HelicsError *err)
Definition: FederateExport.cpp:253
helicsBrokerDataLink
void helicsBrokerDataLink(HelicsBroker broker, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:550
helicsFederateRequestTimeIterativeAsync
void helicsFederateRequestTimeIterativeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:1059
helicsFederateDisconnectComplete
void helicsFederateDisconnectComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:766