 |
helics
3.3.0
|
Go to the documentation of this file.
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);
void helicsFederateInfoLoadFromArgs(HelicsFederateInfo fi, int argc, const char *const *argv, HelicsError *err)
Definition: FederateExport.cpp:178
void helicsFederateSetTag(HelicsFederate fed, const char *tagName, const char *value, HelicsError *err)
Definition: FederateExport.cpp:1352
void helicsCoreSendCommand(HelicsCore core, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:756
void helicsFederateSetGlobal(HelicsFederate fed, const char *valueName, const char *value, HelicsError *err)
Definition: FederateExport.cpp:1331
void helicsQuerySetTarget(HelicsQuery query, const char *target, HelicsError *err)
Definition: helicsExport.cpp:1171
double HelicsTime
Definition: api-data.h:100
HelicsCore helicsCoreClone(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:431
const char * helicsGetBuildFlags(void)
Definition: helicsExport.cpp:36
const char * helicsQueryCoreExecute(HelicsQuery query, HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:1053
void helicsCoreFree(HelicsCore core)
Definition: helicsExport.cpp:924
void helicsFederateSetFlagOption(HelicsFederate fed, int flag, HelicsBool flagValue, HelicsError *err)
Definition: FederateExport.cpp:1225
HelicsTime helicsFederateGetCurrentTime(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1320
void helicsFederateInfoSetBroker(HelicsFederateInfo fi, const char *broker, HelicsError *err)
Definition: FederateExport.cpp:283
HelicsFederate helicsCreateValueFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:447
HelicsTime helicsFederateRequestTimeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1043
HelicsTime helicsFederateRequestTimeAdvance(HelicsFederate fed, HelicsTime timeDelta, HelicsError *err)
Definition: FederateExport.cpp:968
void helicsFederateEnterExecutingModeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:895
int helicsGetOptionValue(const char *val)
Definition: FederateExport.cpp:353
void helicsQuerySetOrdering(HelicsQuery query, int32_t mode, HelicsError *err)
Definition: helicsExport.cpp:1189
void helicsErrorClear(HelicsError *err)
Definition: helicsExport.cpp:66
void helicsFederateDestroy(HelicsFederate fed)
Definition: helicsExport.cpp:906
void helicsBrokerSetTimeBarrier(HelicsBroker broker, HelicsTime barrierTime, HelicsError *err)
Definition: helicsExport.cpp:618
void helicsCoreDestroy(HelicsCore core)
Definition: helicsExport.cpp:918
HelicsBool helicsFederateIsValid(HelicsFederate fed)
Definition: FederateExport.cpp:647
void helicsFederateProcessCommunications(HelicsFederate fed, HelicsTime period, HelicsError *err)
Definition: FederateExport.cpp:1098
HelicsIterationResult helicsFederateEnterExecutingModeIterative(HelicsFederate fed, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:879
void helicsFederateAddDependency(HelicsFederate fed, const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:1395
void helicsFederateEnterExecutingMode(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:834
HelicsBroker helicsBrokerClone(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:516
void helicsFederateEnterExecutingModeIterativeAsync(HelicsFederate fed, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:909
void helicsFederateLocalError(HelicsFederate fed, int errorCode, const char *errorString, HelicsError *err)
Definition: FederateExport.cpp:703
HelicsBool helicsBrokerIsConnected(HelicsBroker broker)
Definition: helicsExport.cpp:539
void * HelicsFederate
Definition: api-data.h:65
HelicsBool helicsFederateIsAsyncOperationCompleted(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:811
void helicsLoadSignalHandlerCallbackNoExit(HelicsBool(*handler)(int), HelicsBool useSeparateThread)
Definition: helicsExport.cpp:183
const char * helicsQueryExecuteComplete(HelicsQuery query, HelicsError *err)
Definition: helicsExport.cpp:1128
void helicsFederateRegisterInterfaces(HelicsFederate fed, const char *file, HelicsError *err)
Definition: FederateExport.cpp:669
void helicsQueryExecuteAsync(HelicsQuery query, HelicsFederate fed, HelicsError *err)
Definition: helicsExport.cpp:1101
void helicsCoreSetGlobal(HelicsCore core, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:743
HelicsFederate helicsCreateMessageFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:492
void helicsFederateFinalize(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:719
HelicsFederate helicsCreateCombinationFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:538
int helicsGetOptionIndex(const char *val)
Definition: FederateExport.cpp:345
void helicsFederateSendCommand(HelicsFederate fed, const char *target, const char *command, HelicsError *err)
Definition: FederateExport.cpp:1470
void helicsFederateSetSeparator(HelicsFederate fed, char separator, HelicsError *err)
Definition: FederateExport.cpp:1311
void helicsCoreDataLink(HelicsCore core, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:563
const char * helicsQueryExecute(HelicsQuery query, HelicsFederate fed, HelicsError *err)
Definition: helicsExport.cpp:1025
HelicsFederate helicsFederateClone(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:557
HelicsCore helicsCreateCore(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:361
void helicsFederateEnterExecutingModeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:923
void helicsQueryFree(HelicsQuery query)
Definition: helicsExport.cpp:1198
void helicsFederateGlobalError(HelicsFederate fed, int errorCode, const char *errorString, HelicsError *err)
Definition: FederateExport.cpp:687
void helicsFederateLogWarningMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1446
HelicsBool helicsIsCoreTypeAvailable(const char *type)
Definition: helicsExport.cpp:202
void helicsBrokerSendCommand(HelicsBroker broker, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:591
HelicsFederateState helicsFederateGetState(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1117
const char * helicsCoreGetIdentifier(HelicsCore core)
Definition: helicsExport.cpp:793
const char * helicsFederateGetCommand(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1479
HelicsTime helicsFederateRequestTime(HelicsFederate fed, HelicsTime requestTime, HelicsError *err)
Definition: FederateExport.cpp:952
void helicsFederateSetIntegerProperty(HelicsFederate fed, int intProperty, int propertyVal, HelicsError *err)
Definition: FederateExport.cpp:1241
void helicsBrokerFree(HelicsBroker broker)
Definition: helicsExport.cpp:934
const char * helicsBrokerGetIdentifier(HelicsBroker broker)
Definition: helicsExport.cpp:783
void helicsFederateDisconnectAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:750
void helicsBrokerDisconnect(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:890
void helicsFederateProtect(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:604
void helicsFederateSetTimeProperty(HelicsFederate fed, int timeProperty, HelicsTime time, HelicsError *err)
Definition: FederateExport.cpp:1211
HelicsCore helicsCreateCoreFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:396
HelicsError helicsErrorInitialize(void)
Definition: helicsExport.cpp:57
void helicsFederateInfoSetTimeProperty(HelicsFederateInfo fi, int timeProperty, HelicsTime propertyValue, HelicsError *err)
Definition: FederateExport.cpp:392
void helicsBrokerClearTimeBarrier(HelicsBroker broker)
Definition: helicsExport.cpp:627
const char * helicsGetCompilerVersion(void)
Definition: helicsExport.cpp:41
HelicsTime helicsFederateRequestNextStep(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:984
HelicsFederateInfo helicsCreateFederateInfo(void)
Definition: FederateExport.cpp:131
void helicsFederateSetLogFile(HelicsFederate fed, const char *logFile, HelicsError *err)
Definition: FederateExport.cpp:1416
void * HelicsFederateInfo
Definition: api-data.h:71
void helicsCloseLibrary(void)
Definition: helicsExport.cpp:973
const char * helicsFederateGetName(HelicsFederate fed)
Definition: FederateExport.cpp:1201
void helicsFederateUnProtect(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:615
HelicsFederate helicsCreateMessageFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:466
void * HelicsBroker
Definition: api-data.h:60
void helicsCoreGlobalError(HelicsCore core, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:645
HelicsBool helicsQueryIsCompleted(HelicsQuery query)
Definition: helicsExport.cpp:1151
void helicsFederateInfoFree(HelicsFederateInfo fi)
Definition: FederateExport.cpp:167
void helicsCleanupLibrary(void)
Definition: helicsExport.cpp:1209
void helicsFederateInfoSetFlagOption(HelicsFederateInfo fi, int flag, HelicsBool value, HelicsError *err)
Definition: FederateExport.cpp:369
void helicsFederateEnterInitializingModeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:797
HelicsBroker helicsCreateBrokerFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:483
void helicsFederateInfoSetCoreInitString(HelicsFederateInfo fi, const char *coreInit, HelicsError *err)
Definition: FederateExport.cpp:225
void helicsFederateInfoSetCoreName(HelicsFederateInfo fi, const char *corename, HelicsError *err)
Definition: FederateExport.cpp:211
int helicsFederateGetIntegerProperty(HelicsFederate fed, int intProperty, HelicsError *err)
Definition: FederateExport.cpp:1294
HelicsTime helicsFederateRequestTimeIterative(HelicsFederate fed, HelicsTime requestTime, HelicsIterationRequest iterate, HelicsIterationResult *outIteration, HelicsError *err)
Definition: FederateExport.cpp:1000
const char * helicsGetSystemInfo(void)
Definition: helicsExport.cpp:46
int helicsGetFlagIndex(const char *val)
Definition: FederateExport.cpp:337
void helicsFederateLogDebugMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1456
void helicsCoreDisconnect(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:853
void helicsFederateLogInfoMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1451
void helicsBrokerSendOrderedCommand(HelicsBroker broker, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:600
void helicsFederateLogLevelMessage(HelicsFederate fed, int loglevel, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1461
HelicsBool helicsCoreConnect(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:835
void helicsFederateInfoSetCoreTypeFromString(HelicsFederateInfo fi, const char *coretype, HelicsError *err)
Definition: FederateExport.cpp:262
const char * helicsFederateGetCommandSource(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1494
void helicsFederateInfoSetLocalPort(HelicsFederateInfo fi, const char *localPort, HelicsError *err)
Definition: FederateExport.cpp:320
void helicsFederateInfoLoadFromString(HelicsFederateInfo fi, const char *args, HelicsError *err)
Definition: FederateExport.cpp:197
void helicsFederateFinalizeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:729
void helicsFederateDisconnect(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:734
HelicsBool helicsBrokerIsValid(HelicsBroker broker)
Definition: helicsExport.cpp:530
const char * helicsFederateGetTag(HelicsFederate fed, const char *tagName, HelicsError *err)
Definition: FederateExport.cpp:1372
void helicsQuerySetQueryString(HelicsQuery query, const char *queryString, HelicsError *err)
Definition: helicsExport.cpp:1180
void helicsBrokerMakeConnections(HelicsBroker broker, const char *file, HelicsError *err)
Definition: helicsExport.cpp:680
HelicsFederateState
Definition: api-data.h:139
HelicsBroker helicsCreateBroker(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:455
void helicsBrokerAddDestinationFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:667
Definition: api-data.h:169
HelicsIterationResult
Definition: api-data.h:129
HelicsFederate helicsCreateCombinationFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:512
void helicsClearSignalHandler()
Definition: helicsExport.cpp:113
void helicsBrokerSetLogFile(HelicsBroker broker, const char *logFileName, HelicsError *err)
Definition: helicsExport.cpp:609
HelicsBool helicsFederateGetFlagOption(HelicsFederate fed, int flag, HelicsError *err)
Definition: FederateExport.cpp:1276
void helicsLoadSignalHandlerCallback(HelicsBool(*handler)(int), HelicsBool useSeparateThread)
Definition: helicsExport.cpp:164
void helicsCoreAddSourceFilterToEndpoint(HelicsCore core, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:694
HelicsBool helicsFederateIsProtected(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:630
void helicsAbort(int errorCode, const char *errorString)
Definition: helicsExport.cpp:983
void * HelicsCore
Definition: api-data.h:54
void helicsCoreSendOrderedCommand(HelicsCore core, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:765
const char * helicsQueryBrokerExecute(HelicsQuery query, HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:1076
void helicsCoreSetReadyToInit(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:826
HelicsTime helicsFederateRequestTimeIterativeComplete(HelicsFederate fed, HelicsIterationResult *outIterate, HelicsError *err)
Definition: FederateExport.cpp:1073
const char * helicsGetVersion(void)
Definition: helicsExport.cpp:31
void helicsFederateFinalizeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:724
void helicsFederateInfoSetBrokerKey(HelicsFederateInfo fi, const char *brokerkey, HelicsError *err)
Definition: FederateExport.cpp:297
void helicsFederateFree(HelicsFederate fed)
Definition: helicsExport.cpp:944
void helicsBrokerAddSourceFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:654
void helicsFederateRequestTimeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsError *err)
Definition: FederateExport.cpp:1029
void helicsFederateInfoSetBrokerInitString(HelicsFederateInfo fi, const char *brokerInit, HelicsError *err)
Definition: FederateExport.cpp:239
void helicsFederateEnterInitializingMode(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:783
Data structures for the C api.
void helicsCoreAddDestinationFilterToEndpoint(HelicsCore core, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:707
HelicsTime helicsFederateGetTimeProperty(HelicsFederate fed, int timeProperty, HelicsError *err)
Definition: FederateExport.cpp:1257
HelicsBool helicsBrokerWaitForDisconnect(HelicsBroker broker, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:870
int helicsGetDataType(const char *val)
Definition: FederateExport.cpp:361
void helicsFederateInfoSetIntegerProperty(HelicsFederateInfo fi, int intProperty, int propertyValue, HelicsError *err)
Definition: FederateExport.cpp:410
HelicsQuery helicsCreateQuery(const char *target, const char *query)
Definition: helicsExport.cpp:1012
void helicsFederateEnterInitializingModeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:820
HelicsFederate helicsCreateValueFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:420
void helicsBrokerSetGlobal(HelicsBroker broker, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:578
void helicsBrokerGlobalError(HelicsBroker broker, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:636
void helicsFederateLogErrorMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1441
void helicsLoadSignalHandler()
Definition: helicsExport.cpp:103
const char * helicsFederateWaitCommand(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1504
void * HelicsQuery
Definition: api-data.h:77
HelicsBool helicsCoreIsConnected(HelicsCore core)
Definition: helicsExport.cpp:734
void helicsFederateInfoSetBrokerPort(HelicsFederateInfo fi, int brokerPort, HelicsError *err)
Definition: FederateExport.cpp:311
const char * helicsBrokerGetAddress(HelicsBroker broker)
Definition: helicsExport.cpp:804
int helicsGetPropertyIndex(const char *val)
Definition: FederateExport.cpp:329
HelicsFederateInfo helicsFederateInfoClone(HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:157
void helicsLoadThreadedSignalHandler()
Definition: helicsExport.cpp:108
HelicsIterationResult helicsFederateEnterExecutingModeIterativeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:936
void helicsFederateInfoSetSeparator(HelicsFederateInfo fi, char separator, HelicsError *err)
Definition: FederateExport.cpp:401
const char * helicsCoreGetAddress(HelicsCore core)
Definition: helicsExport.cpp:815
void helicsCoreMakeConnections(HelicsCore core, const char *file, HelicsError *err)
Definition: helicsExport.cpp:720
HelicsBool helicsCoreIsValid(HelicsCore core)
Definition: helicsExport.cpp:446
HelicsCore helicsFederateGetCore(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:653
void helicsCoreSetLogFile(HelicsCore core, const char *logFileName, HelicsError *err)
Definition: helicsExport.cpp:774
HelicsFederate helicsGetFederateByName(const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:573
HelicsBool helicsCoreWaitForDisconnect(HelicsCore core, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:880
void helicsBrokerDestroy(HelicsBroker broker)
Definition: helicsExport.cpp:912
int HelicsBool
Definition: api-data.h:112
HelicsIterationRequest
Definition: api-data.h:120
void helicsFederateInfoSetCoreType(HelicsFederateInfo fi, int coretype, HelicsError *err)
Definition: FederateExport.cpp:253
void helicsBrokerDataLink(HelicsBroker broker, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:550
void helicsFederateRequestTimeIterativeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:1059
void helicsFederateDisconnectComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:766