8 #ifndef HELICS_APISHARED_FUNCTIONS_H_
9 #define HELICS_APISHARED_FUNCTIONS_H_
17 #include "helics_export.h"
96 HELICS_EXPORT
void helicsAbort(
int errorCode,
const char* errorString);
Data structures for the C api.
void * HelicsFederateInfo
Definition: api-data.h:71
void * HelicsCore
Definition: api-data.h:54
double HelicsTime
Definition: api-data.h:100
HelicsIterationResult
Definition: api-data.h:131
int HelicsBool
Definition: api-data.h:112
void * HelicsQuery
Definition: api-data.h:77
HelicsFederateState
Definition: api-data.h:141
HelicsIterationRequest
Definition: api-data.h:120
void * HelicsFederate
Definition: api-data.h:65
void * HelicsBroker
Definition: api-data.h:60
void helicsFederateAddAlias(HelicsFederate fed, const char *interfaceName, const char *alias, HelicsError *err)
Definition: FederateExport.cpp:1652
void helicsQueryExecuteAsync(HelicsQuery query, HelicsFederate fed, HelicsError *err)
Definition: helicsExport.cpp:1209
void helicsFederateEnterInitializingModeIterative(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:924
void helicsFederateInfoLoadFromArgs(HelicsFederateInfo fedInfo, int argc, const char *const *argv, HelicsError *err)
Definition: FederateExport.cpp:216
HelicsBool helicsIsCoreTypeAvailable(const char *type)
Definition: helicsExport.cpp:202
void helicsCoreSetGlobal(HelicsCore core, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:800
void helicsBrokerSetTimeBarrier(HelicsBroker broker, HelicsTime barrierTime, HelicsError *err)
Definition: helicsExport.cpp:675
const char * helicsGetVersion(void)
Definition: helicsExport.cpp:31
HelicsTime helicsFederateRequestTimeIterativeComplete(HelicsFederate fed, HelicsIterationResult *outIterate, HelicsError *err)
Definition: FederateExport.cpp:1209
HelicsBool helicsFederateIsProtected(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:714
void helicsFederateSetGlobal(HelicsFederate fed, const char *valueName, const char *value, HelicsError *err)
Definition: FederateExport.cpp:1629
void helicsFederateEnterInitializingModeIterativeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:938
void helicsCoreDataLink(HelicsCore core, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:569
HelicsIterationResult helicsFederateEnterExecutingModeIterativeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1072
const char * helicsFederateWaitCommand(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1829
HelicsFederate helicsCreateValueFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:485
const char * helicsFederateGetCommand(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1804
const char * helicsBrokerGetIdentifier(HelicsBroker broker)
Definition: helicsExport.cpp:868
HelicsCore helicsFederateGetCore(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:737
HelicsFederate helicsCreateCombinationFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:576
void helicsCoreSendCommand(HelicsCore core, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:820
void helicsCoreSetLogFile(HelicsCore core, const char *logFileName, HelicsError *err)
Definition: helicsExport.cpp:852
void helicsCloseLibrary(void)
Definition: helicsExport.cpp:1081
int helicsGetDataType(const char *val)
Definition: FederateExport.cpp:399
int helicsGetFlagIndex(const char *val)
Definition: FederateExport.cpp:375
const char * helicsBrokerGetAddress(HelicsBroker broker)
Definition: helicsExport.cpp:889
void helicsFederateLogInfoMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1776
void helicsBrokerDataLink(HelicsBroker broker, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:556
void helicsFederateRequestTimeIterativeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:1195
const char * helicsFederateGetTag(HelicsFederate fed, const char *tagName, HelicsError *err)
Definition: FederateExport.cpp:1697
void helicsFederateEnterExecutingModeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1059
void helicsFederateSetIntegerProperty(HelicsFederate fed, int intProperty, int propertyVal, HelicsError *err)
Definition: FederateExport.cpp:1539
const char * helicsGetSystemInfo(void)
Definition: helicsExport.cpp:46
void helicsFederateSetTag(HelicsFederate fed, const char *tagName, const char *value, HelicsError *err)
Definition: FederateExport.cpp:1677
HelicsBool helicsQueryIsCompleted(HelicsQuery query)
Definition: helicsExport.cpp:1259
void helicsFederateEnterInitializingModeIterativeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:952
void helicsFederateLogWarningMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1771
void helicsCoreDisconnect(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:945
void helicsFederateInfoLoadFromString(HelicsFederateInfo fedInfo, const char *args, HelicsError *err)
Definition: FederateExport.cpp:235
HelicsFederate helicsFederateClone(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:641
void helicsFederateInfoSetSeparator(HelicsFederateInfo fedInfo, char separator, HelicsError *err)
Definition: FederateExport.cpp:439
void helicsFederateAddDependency(HelicsFederate fed, const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:1720
void helicsBrokerGlobalError(HelicsBroker broker, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:693
HelicsTime helicsFederateGetCurrentTime(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1618
HelicsFederate helicsCreateMessageFederate(const char *fedName, HelicsFederateInfo fedInfo, HelicsError *err)
Definition: FederateExport.cpp:504
void helicsLoadSignalHandler()
Definition: helicsExport.cpp:103
void helicsFederateFinalize(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:803
HelicsFederateInfo helicsCreateFederateInfo(void)
Definition: FederateExport.cpp:169
HelicsTime helicsFederateRequestTimeAdvance(HelicsFederate fed, HelicsTime timeDelta, HelicsError *err)
Definition: FederateExport.cpp:1104
HelicsBool helicsBrokerWaitForDisconnect(HelicsBroker broker, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:962
void helicsFederateInfoFree(HelicsFederateInfo fedInfo)
Definition: FederateExport.cpp:205
void helicsCoreSendOrderedCommand(HelicsCore core, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:836
void helicsFederateSendCommand(HelicsFederate fed, const char *target, const char *command, HelicsError *err)
Definition: FederateExport.cpp:1795
void helicsFederateSetTimeProperty(HelicsFederate fed, int timeProperty, HelicsTime time, HelicsError *err)
Definition: FederateExport.cpp:1509
void helicsQuerySetTarget(HelicsQuery query, const char *target, HelicsError *err)
Definition: helicsExport.cpp:1279
HelicsTime helicsFederateRequestTimeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1179
void helicsFederateInfoSetFlagOption(HelicsFederateInfo fedInfo, int flag, HelicsBool value, HelicsError *err)
Definition: FederateExport.cpp:407
void helicsFederateEnterInitializingModeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:910
const char * helicsCoreGetAddress(HelicsCore core)
Definition: helicsExport.cpp:900
void helicsFederateInfoSetBrokerPort(HelicsFederateInfo fedInfo, int brokerPort, HelicsError *err)
Definition: FederateExport.cpp:349
void helicsQuerySetOrdering(HelicsQuery query, int32_t mode, HelicsError *err)
Definition: helicsExport.cpp:1297
HelicsBool helicsFederateIsValid(HelicsFederate fed)
Definition: FederateExport.cpp:731
void helicsBrokerSendCommand(HelicsBroker broker, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:648
void helicsFederateLogErrorMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1766
HelicsBool helicsBrokerIsValid(HelicsBroker broker)
Definition: helicsExport.cpp:536
HelicsBroker helicsBrokerClone(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:522
HelicsBroker helicsCreateBrokerFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:489
HelicsCore helicsCoreClone(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:431
void helicsCoreDestroy(HelicsCore core)
Definition: helicsExport.cpp:1026
void helicsCoreAddAlias(HelicsCore core, const char *interfaceName, const char *alias, HelicsError *err)
Definition: helicsExport.cpp:600
void helicsFederateEnterExecutingMode(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:966
void helicsLoadSignalHandlerCallbackNoExit(HelicsBool(*handler)(int), HelicsBool useSeparateThread)
Definition: helicsExport.cpp:183
void helicsFederateInfoSetLocalPort(HelicsFederateInfo fedInfo, const char *localPort, HelicsError *err)
Definition: FederateExport.cpp:358
HelicsTime helicsFederateRequestNextStep(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1120
int helicsGetOptionValue(const char *val)
Definition: FederateExport.cpp:391
void helicsBrokerMakeConnections(HelicsBroker broker, const char *file, HelicsError *err)
Definition: helicsExport.cpp:737
HelicsFederate helicsCreateCombinationFederate(const char *fedName, HelicsFederateInfo fedInfo, HelicsError *err)
Definition: FederateExport.cpp:550
HelicsFederate helicsCreateCallbackFederate(const char *fedName, HelicsFederateInfo fedInfo, HelicsError *err)
Definition: FederateExport.cpp:596
void helicsFederateUnProtect(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:699
HelicsTime helicsFederateRequestTime(HelicsFederate fed, HelicsTime requestTime, HelicsError *err)
Definition: FederateExport.cpp:1088
void helicsFederateDestroy(HelicsFederate fed)
Definition: helicsExport.cpp:1014
void helicsCoreMakeConnections(HelicsCore core, const char *file, HelicsError *err)
Definition: helicsExport.cpp:777
HelicsFederateInfo helicsFederateInfoClone(HelicsFederateInfo fedInfo, HelicsError *err)
Definition: FederateExport.cpp:195
void helicsFederateInfoSetBrokerInitString(HelicsFederateInfo fedInfo, const char *brokerInit, HelicsError *err)
Definition: FederateExport.cpp:277
HelicsFederate helicsGetFederateByName(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:657
const char * helicsFederateGetCommandSource(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1819
void helicsClearSignalHandler()
Definition: helicsExport.cpp:113
void helicsCoreAddSourceFilterToEndpoint(HelicsCore core, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:751
void helicsFederateFinalizeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:808
const char * helicsGetBuildFlags(void)
Definition: helicsExport.cpp:36
const char * helicsQueryBrokerExecute(HelicsQuery query, HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:1184
void helicsQueryFree(HelicsQuery query)
Definition: helicsExport.cpp:1306
void helicsFederateLocalError(HelicsFederate fed, int errorCode, const char *errorString, HelicsError *err)
Definition: FederateExport.cpp:787
int helicsFederateGetIntegerProperty(HelicsFederate fed, int intProperty, HelicsError *err)
Definition: FederateExport.cpp:1592
void helicsCoreAddDestinationFilterToEndpoint(HelicsCore core, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:764
void helicsFederateGlobalError(HelicsFederate fed, int errorCode, const char *errorString, HelicsError *err)
Definition: FederateExport.cpp:771
void helicsBrokerSendOrderedCommand(HelicsBroker broker, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:657
HelicsBool helicsCoreIsValid(HelicsCore core)
Definition: helicsExport.cpp:452
const char * helicsCoreGetIdentifier(HelicsCore core)
Definition: helicsExport.cpp:878
void helicsFederateRegisterInterfaces(HelicsFederate fed, const char *file, HelicsError *err)
Definition: FederateExport.cpp:753
void helicsCoreSetReadyToInit(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:911
HelicsBool helicsFederateGetFlagOption(HelicsFederate fed, int flag, HelicsError *err)
Definition: FederateExport.cpp:1574
void helicsBrokerAddDestinationFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:724
HelicsTime helicsFederateRequestTimeIterative(HelicsFederate fed, HelicsTime requestTime, HelicsIterationRequest iterate, HelicsIterationResult *outIteration, HelicsError *err)
Definition: FederateExport.cpp:1136
void helicsFederateLogDebugMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1781
void helicsCoreGlobalError(HelicsCore core, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:702
void helicsFederateFree(HelicsFederate fed)
Definition: helicsExport.cpp:1052
HelicsQuery helicsCreateQuery(const char *target, const char *query)
Definition: helicsExport.cpp:1120
void helicsFederateLogLevelMessage(HelicsFederate fed, int loglevel, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1786
void helicsFederateDisconnectAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:834
HelicsCore helicsCreateCore(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:361
HelicsIterationResult helicsFederateEnterExecutingModeIterative(HelicsFederate fed, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:1015
HelicsTime helicsFederateGetTimeProperty(HelicsFederate fed, int timeProperty, HelicsError *err)
Definition: FederateExport.cpp:1555
HelicsCore helicsCreateCoreFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:396
void helicsBrokerClearTimeBarrier(HelicsBroker broker)
Definition: helicsExport.cpp:684
void helicsFederateInfoSetBroker(HelicsFederateInfo fedInfo, const char *broker, HelicsError *err)
Definition: FederateExport.cpp:321
HelicsBool helicsFederateIsAsyncOperationCompleted(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:895
void helicsFederateInfoSetCoreInitString(HelicsFederateInfo fedInfo, const char *coreInit, HelicsError *err)
Definition: FederateExport.cpp:263
void helicsFederateEnterExecutingModeIterativeAsync(HelicsFederate fed, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:1045
HelicsBool helicsCoreConnect(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:927
int helicsGetPropertyIndex(const char *val)
Definition: FederateExport.cpp:367
void helicsFederateSetFlagOption(HelicsFederate fed, int flag, HelicsBool flagValue, HelicsError *err)
Definition: FederateExport.cpp:1523
HelicsFederate helicsCreateCallbackFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:622
const char * helicsFederateGetName(HelicsFederate fed)
Definition: FederateExport.cpp:1499
HelicsBool helicsBrokerIsConnected(HelicsBroker broker)
Definition: helicsExport.cpp:545
void helicsFederateInfoSetCoreType(HelicsFederateInfo fedInfo, int coretype, HelicsError *err)
Definition: FederateExport.cpp:291
void helicsCoreFree(HelicsCore core)
Definition: helicsExport.cpp:1032
void helicsFederateInfoSetIntegerProperty(HelicsFederateInfo fedInfo, int intProperty, int propertyValue, HelicsError *err)
Definition: FederateExport.cpp:448
HelicsBroker helicsCreateBroker(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:461
const char * helicsQueryExecute(HelicsQuery query, HelicsFederate fed, HelicsError *err)
Definition: helicsExport.cpp:1133
void helicsLoadSignalHandlerCallback(HelicsBool(*handler)(int), HelicsBool useSeparateThread)
Definition: helicsExport.cpp:164
void helicsErrorClear(HelicsError *err)
Definition: helicsExport.cpp:66
int helicsGetOptionIndex(const char *val)
Definition: FederateExport.cpp:383
void helicsFederateProtect(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:688
HelicsBool helicsCoreWaitForDisconnect(HelicsCore core, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:980
void helicsFederateFinalizeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:813
void helicsBrokerSetLogFile(HelicsBroker broker, const char *logFileName, HelicsError *err)
Definition: helicsExport.cpp:666
HelicsFederate helicsCreateValueFederate(const char *fedName, HelicsFederateInfo fedInfo, HelicsError *err)
Definition: FederateExport.cpp:458
void helicsCleanupLibrary(void)
Definition: helicsExport.cpp:1317
HelicsFederate helicsCreateMessageFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:530
void helicsLoadThreadedSignalHandler()
Definition: helicsExport.cpp:108
void helicsBrokerDisconnect(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:998
const char * helicsQueryExecuteComplete(HelicsQuery query, HelicsError *err)
Definition: helicsExport.cpp:1236
void helicsAbort(int errorCode, const char *errorString)
Definition: helicsExport.cpp:1091
void helicsFederateRequestTimeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsError *err)
Definition: FederateExport.cpp:1165
void helicsFederateSetLogFile(HelicsFederate fed, const char *logFile, HelicsError *err)
Definition: FederateExport.cpp:1741
void helicsFederateEnterInitializingModeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:881
HelicsError helicsErrorInitialize(void)
Definition: helicsExport.cpp:57
void helicsBrokerAddSourceFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:711
const char * helicsGetCompilerVersion(void)
Definition: helicsExport.cpp:41
void helicsQuerySetQueryString(HelicsQuery query, const char *queryString, HelicsError *err)
Definition: helicsExport.cpp:1288
const char * helicsQueryCoreExecute(HelicsQuery query, HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:1161
void helicsFederateInfoSetCoreName(HelicsFederateInfo fedInfo, const char *corename, HelicsError *err)
Definition: FederateExport.cpp:249
void helicsBrokerSetGlobal(HelicsBroker broker, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:584
void helicsBrokerFree(HelicsBroker broker)
Definition: helicsExport.cpp:1042
void helicsFederateInfoSetTimeProperty(HelicsFederateInfo fedInfo, int timeProperty, HelicsTime propertyValue, HelicsError *err)
Definition: FederateExport.cpp:430
void helicsFederateInfoSetBrokerKey(HelicsFederateInfo fedInfo, const char *brokerkey, HelicsError *err)
Definition: FederateExport.cpp:335
void helicsFederateEnterInitializingMode(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:867
void helicsBrokerDestroy(HelicsBroker broker)
Definition: helicsExport.cpp:1020
void helicsFederateDisconnectComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:850
HelicsFederateState helicsFederateGetState(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1253
void helicsFederateSetSeparator(HelicsFederate fed, char separator, HelicsError *err)
Definition: FederateExport.cpp:1609
void helicsFederateDisconnect(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:818
void helicsBrokerAddAlias(HelicsBroker broker, const char *interfaceName, const char *alias, HelicsError *err)
Definition: helicsExport.cpp:624
void helicsFederateInfoSetCoreTypeFromString(HelicsFederateInfo fedInfo, const char *coretype, HelicsError *err)
Definition: FederateExport.cpp:300
void helicsFederateEnterExecutingModeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1031
HelicsBool helicsCoreIsConnected(HelicsCore core)
Definition: helicsExport.cpp:791
void helicsFederateProcessCommunications(HelicsFederate fed, HelicsTime period, HelicsError *err)
Definition: FederateExport.cpp:1234
Definition: api-data.h:171