 |
helics
3.0.1
|
Go to the documentation of this file.
8 #ifndef HELICS_APISHARED_FUNCTIONS_H_
9 #define HELICS_APISHARED_FUNCTIONS_H_
17 #include "helics_export.h"
73 HELICS_EXPORT
void helicsAbort(
int errorCode,
const char* errorString);
void helicsFederateInfoLoadFromArgs(HelicsFederateInfo fi, int argc, const char *const *argv, HelicsError *err)
Definition: FederateExport.cpp:176
void helicsFederateSetTag(HelicsFederate fed, const char *tagName, const char *value, HelicsError *err)
Definition: FederateExport.cpp:1190
void helicsCoreSendCommand(HelicsCore core, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:685
void helicsFederateSetGlobal(HelicsFederate fed, const char *valueName, const char *value, HelicsError *err)
Definition: FederateExport.cpp:1169
void helicsQuerySetTarget(HelicsQuery query, const char *target, HelicsError *err)
Definition: helicsExport.cpp:1072
double HelicsTime
Definition: api-data.h:90
HelicsCore helicsCoreClone(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:336
const char * helicsGetBuildFlags(void)
Definition: helicsExport.cpp:34
const char * helicsQueryCoreExecute(HelicsQuery query, HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:973
void helicsCoreFree(HelicsCore core)
Definition: helicsExport.cpp:853
void helicsFederateSetFlagOption(HelicsFederate fed, int flag, HelicsBool flagValue, HelicsError *err)
Definition: FederateExport.cpp:1063
HelicsTime helicsFederateGetCurrentTime(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1158
void helicsFederateInfoSetBroker(HelicsFederateInfo fi, const char *broker, HelicsError *err)
Definition: FederateExport.cpp:267
HelicsFederate helicsCreateValueFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:431
void helicsLoadSignalHandlerCallback(HelicsBool(*handler)(int))
Definition: helicsExport.cpp:97
HelicsTime helicsFederateRequestTimeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:953
HelicsTime helicsFederateRequestTimeAdvance(HelicsFederate fed, HelicsTime timeDelta, HelicsError *err)
Definition: FederateExport.cpp:878
void helicsFederateEnterExecutingModeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:805
int helicsGetOptionValue(const char *val)
Definition: FederateExport.cpp:337
void helicsQuerySetOrdering(HelicsQuery query, int32_t mode, HelicsError *err)
Definition: helicsExport.cpp:1090
void helicsErrorClear(HelicsError *err)
Definition: helicsExport.cpp:57
void helicsFederateDestroy(HelicsFederate fed)
Definition: helicsExport.cpp:835
void helicsBrokerSetTimeBarrier(HelicsBroker broker, HelicsTime barrierTime, HelicsError *err)
Definition: helicsExport.cpp:547
void helicsCoreDestroy(HelicsCore core)
Definition: helicsExport.cpp:847
HelicsBool helicsFederateIsValid(HelicsFederate fed)
Definition: FederateExport.cpp:557
HelicsIterationResult helicsFederateEnterExecutingModeIterative(HelicsFederate fed, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:789
void helicsFederateAddDependency(HelicsFederate fed, const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:1233
void helicsFederateEnterExecutingMode(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:744
HelicsBroker helicsBrokerClone(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:445
void helicsFederateEnterExecutingModeIterativeAsync(HelicsFederate fed, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:819
void helicsFederateLocalError(HelicsFederate fed, int errorCode, const char *errorString, HelicsError *err)
Definition: FederateExport.cpp:613
HelicsBool helicsBrokerIsConnected(HelicsBroker broker)
Definition: helicsExport.cpp:468
void * HelicsFederate
Definition: api-data.h:60
HelicsBool helicsFederateIsAsyncOperationCompleted(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:721
const char * helicsQueryExecuteComplete(HelicsQuery query, HelicsError *err)
Definition: helicsExport.cpp:1044
void helicsFederateRegisterInterfaces(HelicsFederate fed, const char *file, HelicsError *err)
Definition: FederateExport.cpp:579
void helicsQueryExecuteAsync(HelicsQuery query, HelicsFederate fed, HelicsError *err)
Definition: helicsExport.cpp:1018
void helicsCoreSetGlobal(HelicsCore core, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:672
HelicsFederate helicsCreateMessageFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:476
void helicsFederateFinalize(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:629
HelicsFederate helicsCreateCombinationFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:522
int helicsGetOptionIndex(const char *val)
Definition: FederateExport.cpp:329
void helicsFederateSendCommand(HelicsFederate fed, const char *target, const char *command, HelicsError *err)
Definition: FederateExport.cpp:1308
void helicsFederateSetSeparator(HelicsFederate fed, char separator, HelicsError *err)
Definition: FederateExport.cpp:1149
void helicsCoreDataLink(HelicsCore core, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:492
const char * helicsQueryExecute(HelicsQuery query, HelicsFederate fed, HelicsError *err)
Definition: helicsExport.cpp:953
HelicsFederate helicsFederateClone(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:541
HelicsCore helicsCreateCore(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:266
void helicsFederateEnterExecutingModeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:833
void helicsQueryFree(HelicsQuery query)
Definition: helicsExport.cpp:1099
void helicsFederateGlobalError(HelicsFederate fed, int errorCode, const char *errorString, HelicsError *err)
Definition: FederateExport.cpp:597
void helicsFederateLogWarningMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1284
HelicsBool helicsIsCoreTypeAvailable(const char *type)
Definition: helicsExport.cpp:107
void helicsBrokerSendCommand(HelicsBroker broker, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:520
HelicsFederateState helicsFederateGetState(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1021
const char * helicsCoreGetIdentifier(HelicsCore core)
Definition: helicsExport.cpp:722
const char * helicsFederateGetCommand(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1317
HelicsTime helicsFederateRequestTime(HelicsFederate fed, HelicsTime requestTime, HelicsError *err)
Definition: FederateExport.cpp:862
void helicsFederateSetIntegerProperty(HelicsFederate fed, int intProperty, int propertyVal, HelicsError *err)
Definition: FederateExport.cpp:1079
void helicsBrokerFree(HelicsBroker broker)
Definition: helicsExport.cpp:863
const char * helicsBrokerGetIdentifier(HelicsBroker broker)
Definition: helicsExport.cpp:712
void helicsFederateDisconnectAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:660
void helicsBrokerDisconnect(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:819
void helicsFederateSetTimeProperty(HelicsFederate fed, int timeProperty, HelicsTime time, HelicsError *err)
Definition: FederateExport.cpp:1049
HelicsCore helicsCreateCoreFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:301
HelicsError helicsErrorInitialize(void)
Definition: helicsExport.cpp:48
void helicsFederateInfoSetTimeProperty(HelicsFederateInfo fi, int timeProperty, HelicsTime propertyValue, HelicsError *err)
Definition: FederateExport.cpp:376
void helicsBrokerClearTimeBarrier(HelicsBroker broker)
Definition: helicsExport.cpp:556
const char * helicsGetCompilerVersion(void)
Definition: helicsExport.cpp:39
HelicsTime helicsFederateRequestNextStep(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:894
HelicsFederateInfo helicsCreateFederateInfo(void)
Definition: FederateExport.cpp:129
void helicsFederateSetLogFile(HelicsFederate fed, const char *logFile, HelicsError *err)
Definition: FederateExport.cpp:1254
void * HelicsFederateInfo
Definition: api-data.h:66
void helicsCloseLibrary(void)
Definition: helicsExport.cpp:902
const char * helicsFederateGetName(HelicsFederate fed)
Definition: FederateExport.cpp:1039
HelicsFederate helicsCreateMessageFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:450
void * HelicsBroker
Definition: api-data.h:55
void helicsCoreGlobalError(HelicsCore core, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:574
HelicsBool helicsQueryIsCompleted(HelicsQuery query)
Definition: helicsExport.cpp:1059
void helicsFederateInfoFree(HelicsFederateInfo fi)
Definition: FederateExport.cpp:165
void helicsCleanupLibrary(void)
Definition: helicsExport.cpp:1110
void helicsFederateInfoSetFlagOption(HelicsFederateInfo fi, int flag, HelicsBool value, HelicsError *err)
Definition: FederateExport.cpp:353
void helicsFederateEnterInitializingModeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:707
HelicsBroker helicsCreateBrokerFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:412
void helicsFederateInfoSetCoreInitString(HelicsFederateInfo fi, const char *coreInit, HelicsError *err)
Definition: FederateExport.cpp:209
void helicsFederateInfoSetCoreName(HelicsFederateInfo fi, const char *corename, HelicsError *err)
Definition: FederateExport.cpp:195
int helicsFederateGetIntegerProperty(HelicsFederate fed, int intProperty, HelicsError *err)
Definition: FederateExport.cpp:1132
HelicsTime helicsFederateRequestTimeIterative(HelicsFederate fed, HelicsTime requestTime, HelicsIterationRequest iterate, HelicsIterationResult *outIteration, HelicsError *err)
Definition: FederateExport.cpp:910
int helicsGetFlagIndex(const char *val)
Definition: FederateExport.cpp:321
void helicsFederateLogDebugMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1294
void helicsCoreDisconnect(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:782
void helicsFederateLogInfoMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1289
void helicsFederateLogLevelMessage(HelicsFederate fed, int loglevel, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1299
HelicsBool helicsCoreConnect(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:764
void helicsFederateInfoSetCoreTypeFromString(HelicsFederateInfo fi, const char *coretype, HelicsError *err)
Definition: FederateExport.cpp:246
const char * helicsFederateGetCommandSource(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1332
void helicsFederateInfoSetLocalPort(HelicsFederateInfo fi, const char *localPort, HelicsError *err)
Definition: FederateExport.cpp:304
void helicsFederateFinalizeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:639
void helicsFederateDisconnect(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:644
HelicsBool helicsBrokerIsValid(HelicsBroker broker)
Definition: helicsExport.cpp:459
const char * helicsFederateGetTag(HelicsFederate fed, const char *tagName, HelicsError *err)
Definition: FederateExport.cpp:1210
void helicsQuerySetQueryString(HelicsQuery query, const char *queryString, HelicsError *err)
Definition: helicsExport.cpp:1081
void helicsBrokerMakeConnections(HelicsBroker broker, const char *file, HelicsError *err)
Definition: helicsExport.cpp:609
HelicsFederateState
Definition: api-data.h:129
HelicsBroker helicsCreateBroker(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:384
void helicsBrokerAddDestinationFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:596
Definition: api-data.h:160
HelicsIterationResult
Definition: api-data.h:119
HelicsFederate helicsCreateCombinationFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:496
void helicsClearSignalHandler()
Definition: helicsExport.cpp:79
void helicsBrokerSetLogFile(HelicsBroker broker, const char *logFileName, HelicsError *err)
Definition: helicsExport.cpp:538
HelicsBool helicsFederateGetFlagOption(HelicsFederate fed, int flag, HelicsError *err)
Definition: FederateExport.cpp:1114
void helicsCoreAddSourceFilterToEndpoint(HelicsCore core, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:623
void helicsAbort(int errorCode, const char *errorString)
Definition: helicsExport.cpp:913
void * HelicsCore
Definition: api-data.h:49
const char * helicsQueryBrokerExecute(HelicsQuery query, HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:995
void helicsCoreSetReadyToInit(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:755
HelicsTime helicsFederateRequestTimeIterativeComplete(HelicsFederate fed, HelicsIterationResult *outIterate, HelicsError *err)
Definition: FederateExport.cpp:983
const char * helicsGetVersion(void)
Definition: helicsExport.cpp:29
void helicsFederateFinalizeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:634
void helicsFederateInfoSetBrokerKey(HelicsFederateInfo fi, const char *brokerkey, HelicsError *err)
Definition: FederateExport.cpp:281
void helicsFederateFree(HelicsFederate fed)
Definition: helicsExport.cpp:873
void helicsBrokerAddSourceFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:583
void helicsFederateRequestTimeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsError *err)
Definition: FederateExport.cpp:939
void helicsFederateInfoSetBrokerInitString(HelicsFederateInfo fi, const char *brokerInit, HelicsError *err)
Definition: FederateExport.cpp:223
void helicsFederateEnterInitializingMode(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:693
Data structures for the C api.
void helicsCoreAddDestinationFilterToEndpoint(HelicsCore core, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:636
HelicsTime helicsFederateGetTimeProperty(HelicsFederate fed, int timeProperty, HelicsError *err)
Definition: FederateExport.cpp:1095
HelicsBool helicsBrokerWaitForDisconnect(HelicsBroker broker, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:799
int helicsGetDataType(const char *val)
Definition: FederateExport.cpp:345
void helicsFederateInfoSetIntegerProperty(HelicsFederateInfo fi, int intProperty, int propertyValue, HelicsError *err)
Definition: FederateExport.cpp:394
HelicsQuery helicsCreateQuery(const char *target, const char *query)
Definition: helicsExport.cpp:942
void helicsFederateEnterInitializingModeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:730
HelicsFederate helicsCreateValueFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:404
void helicsBrokerSetGlobal(HelicsBroker broker, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:507
void helicsBrokerGlobalError(HelicsBroker broker, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:565
void helicsFederateLogErrorMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1279
void helicsLoadSignalHandler()
Definition: helicsExport.cpp:74
const char * helicsFederateWaitCommand(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1342
void * HelicsQuery
Definition: api-data.h:72
HelicsBool helicsCoreIsConnected(HelicsCore core)
Definition: helicsExport.cpp:663
void helicsFederateInfoSetBrokerPort(HelicsFederateInfo fi, int brokerPort, HelicsError *err)
Definition: FederateExport.cpp:295
const char * helicsBrokerGetAddress(HelicsBroker broker)
Definition: helicsExport.cpp:733
int helicsGetPropertyIndex(const char *val)
Definition: FederateExport.cpp:313
HelicsFederateInfo helicsFederateInfoClone(HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:155
HelicsIterationResult helicsFederateEnterExecutingModeIterativeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:846
void helicsFederateInfoSetSeparator(HelicsFederateInfo fi, char separator, HelicsError *err)
Definition: FederateExport.cpp:385
const char * helicsCoreGetAddress(HelicsCore core)
Definition: helicsExport.cpp:744
void helicsCoreMakeConnections(HelicsCore core, const char *file, HelicsError *err)
Definition: helicsExport.cpp:649
HelicsBool helicsCoreIsValid(HelicsCore core)
Definition: helicsExport.cpp:351
HelicsCore helicsFederateGetCore(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:563
void helicsCoreSetLogFile(HelicsCore core, const char *logFileName, HelicsError *err)
Definition: helicsExport.cpp:703
HelicsFederate helicsGetFederateByName(const char *fedName, HelicsError *err)
Definition: helicsExport.cpp:360
HelicsBool helicsCoreWaitForDisconnect(HelicsCore core, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:809
void helicsBrokerDestroy(HelicsBroker broker)
Definition: helicsExport.cpp:841
int HelicsBool
Definition: api-data.h:102
HelicsIterationRequest
Definition: api-data.h:110
void helicsFederateInfoSetCoreType(HelicsFederateInfo fi, int coretype, HelicsError *err)
Definition: FederateExport.cpp:237
void helicsBrokerDataLink(HelicsBroker broker, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:479
void helicsFederateRequestTimeIterativeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:969
void helicsFederateDisconnectComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:676