 |
helics
2.8.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 helicsQueryFree(helics_query query)
Definition: helicsExport.cpp:1063
void helicsBrokerSetTimeBarrier(helics_broker broker, helics_time barrierTime, helics_error *err)
Definition: helicsExport.cpp:529
void helicsFederateInfoSetCoreName(helics_federate_info fi, const char *corename, helics_error *err)
Definition: FederateExport.cpp:195
helics_iteration_result helicsFederateEnterExecutingModeIterative(helics_federate fed, helics_iteration_request iterate, helics_error *err)
Definition: FederateExport.cpp:765
helics_broker helicsCreateBrokerFromArgs(const char *type, const char *name, int argc, const char *const *argv, helics_error *err)
Definition: helicsExport.cpp:412
int helicsGetOptionIndex(const char *val)
Definition: FederateExport.cpp:329
helics_bool helicsFederateGetFlagOption(helics_federate fed, int flag, helics_error *err)
Definition: FederateExport.cpp:1093
void helicsQuerySetTarget(helics_query query, const char *target, helics_error *err)
Definition: helicsExport.cpp:1036
void helicsFederateGlobalError(helics_federate fed, int errorCode, const char *errorString)
Definition: FederateExport.cpp:575
void helicsFederateLogLevelMessage(helics_federate fed, int loglevel, const char *logmessage, helics_error *err)
Definition: FederateExport.cpp:1235
void helicsFederateLogDebugMessage(helics_federate fed, const char *logmessage, helics_error *err)
Definition: FederateExport.cpp:1230
helics_federate_info helicsCreateFederateInfo(void)
Definition: FederateExport.cpp:129
void helicsFederateFinalizeComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:637
const char * helicsQueryCoreExecute(helics_query query, helics_core core, helics_error *err)
Definition: helicsExport.cpp:937
helics_federate helicsCreateMessageFederateFromConfig(const char *configFile, helics_error *err)
Definition: FederateExport.cpp:454
void helicsFederateLogWarningMessage(helics_federate fed, const char *logmessage, helics_error *err)
Definition: FederateExport.cpp:1220
int helicsGetFlagIndex(const char *val)
Definition: FederateExport.cpp:321
helics_core helicsCreateCoreFromArgs(const char *type, const char *name, int argc, const char *const *argv, helics_error *err)
Definition: helicsExport.cpp:301
void helicsCoreMakeConnections(helics_core core, const char *file, helics_error *err)
Definition: helicsExport.cpp:631
void helicsFederateInfoSetFlagOption(helics_federate_info fi, int flag, helics_bool value, helics_error *err)
Definition: FederateExport.cpp:345
helics_federate_info helicsFederateInfoClone(helics_federate_info fi, helics_error *err)
Definition: FederateExport.cpp:155
helics_bool helicsCoreConnect(helics_core core, helics_error *err)
Definition: helicsExport.cpp:728
void helicsCoreSetLogFile(helics_core core, const char *logFileName, helics_error *err)
Definition: helicsExport.cpp:667
helics_bool helicsIsCoreTypeAvailable(const char *type)
Definition: helicsExport.cpp:107
void helicsFederateEnterExecutingModeAsync(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:781
void helicsCloseLibrary(void)
Definition: helicsExport.cpp:866
helics_federate helicsCreateValueFederate(const char *fedName, helics_federate_info fi, helics_error *err)
Definition: FederateExport.cpp:382
void helicsBrokerGlobalError(helics_broker broker, int errorCode, const char *errorString, helics_error *err)
Definition: helicsExport.cpp:547
double helics_time
Definition: api-data.h:81
void * helics_core
Definition: api-data.h:46
void * helics_query
Definition: api-data.h:66
helics_federate helicsCreateCombinationFederateFromConfig(const char *configFile, helics_error *err)
Definition: FederateExport.cpp:500
helics_bool helicsQueryIsCompleted(helics_query query)
Definition: helicsExport.cpp:1023
helics_iteration_request
Definition: api-data.h:100
helics_core helicsCreateCore(const char *type, const char *name, const char *initString, helics_error *err)
Definition: helicsExport.cpp:266
helics_iteration_result helicsFederateEnterExecutingModeIterativeComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:822
helics_federate helicsFederateClone(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:519
helics_bool helicsCoreWaitForDisconnect(helics_core core, int msToWait, helics_error *err)
Definition: helicsExport.cpp:773
void helicsBrokerMakeConnections(helics_broker broker, const char *file, helics_error *err)
Definition: helicsExport.cpp:591
void helicsFederateEnterInitializingMode(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:669
void helicsFederateSetSeparator(helics_federate fed, char separator, helics_error *err)
Definition: FederateExport.cpp:1128
void helicsBrokerDisconnect(helics_broker broker, helics_error *err)
Definition: helicsExport.cpp:783
const char * helicsQueryExecute(helics_query query, helics_federate fed, helics_error *err)
Definition: helicsExport.cpp:917
helics_bool helicsCoreIsValid(helics_core core)
Definition: helicsExport.cpp:351
helics_time helicsFederateGetTimeProperty(helics_federate fed, int timeProperty, helics_error *err)
Definition: FederateExport.cpp:1074
helics_bool helicsBrokerIsValid(helics_broker broker)
Definition: helicsExport.cpp:459
void helicsCleanupLibrary(void)
Definition: helicsExport.cpp:1073
int helicsFederateGetIntegerProperty(helics_federate fed, int intProperty, helics_error *err)
Definition: FederateExport.cpp:1111
const char * helicsBrokerGetIdentifier(helics_broker broker)
Definition: helicsExport.cpp:676
void helicsCoreDisconnect(helics_core core, helics_error *err)
Definition: helicsExport.cpp:746
const char * helicsCoreGetAddress(helics_core core)
Definition: helicsExport.cpp:708
void helicsBrokerAddSourceFilterToEndpoint(helics_broker broker, const char *filter, const char *endpoint, helics_error *err)
Definition: helicsExport.cpp:565
void helicsBrokerSetGlobal(helics_broker broker, const char *valueName, const char *value, helics_error *err)
Definition: helicsExport.cpp:507
helics_federate_state
Definition: api-data.h:119
helics_federate helicsCreateValueFederateFromConfig(const char *configFile, helics_error *err)
Definition: FederateExport.cpp:409
helics_bool helicsFederateIsValid(helics_federate fed)
Definition: FederateExport.cpp:535
void helicsFederateInfoFree(helics_federate_info fi)
Definition: FederateExport.cpp:165
void helicsFederateSetFlagOption(helics_federate fed, int flag, helics_bool flagValue, helics_error *err)
Definition: FederateExport.cpp:1042
helics_error helicsErrorInitialize(void)
Definition: helicsExport.cpp:47
helics_bool helicsCoreIsConnected(helics_core core)
Definition: helicsExport.cpp:645
void helicsCoreSetGlobal(helics_core core, const char *valueName, const char *value, helics_error *err)
Definition: helicsExport.cpp:654
const char * helicsGetCompilerVersion(void)
Definition: helicsExport.cpp:38
void helicsBrokerFree(helics_broker broker)
Definition: helicsExport.cpp:827
void helicsFederateInfoSetCoreType(helics_federate_info fi, int coretype, helics_error *err)
Definition: FederateExport.cpp:237
const char * helicsFederateGetName(helics_federate fed)
Definition: FederateExport.cpp:1018
const char * helicsGetVersion(void)
Definition: helicsExport.cpp:28
void helicsCoreGlobalError(helics_core core, int errorCode, const char *errorString, helics_error *err)
Definition: helicsExport.cpp:556
const char * helicsCoreGetIdentifier(helics_core core)
Definition: helicsExport.cpp:686
void helicsFederateDestroy(helics_federate fed)
Definition: helicsExport.cpp:799
void helicsLoadSignalHandler()
Definition: helicsExport.cpp:74
helics_time helicsFederateRequestTime(helics_federate fed, helics_time requestTime, helics_error *err)
Definition: FederateExport.cpp:838
void helicsFederateEnterInitializingModeComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:706
void helicsFederateInfoSetBrokerKey(helics_federate_info fi, const char *brokerkey, helics_error *err)
Definition: FederateExport.cpp:281
helics_time helicsFederateRequestTimeIterative(helics_federate fed, helics_time requestTime, helics_iteration_request iterate, helics_iteration_result *outIteration, helics_error *err)
Definition: FederateExport.cpp:886
void helicsFederateEnterInitializingModeAsync(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:683
void helicsFederateAddDependency(helics_federate fed, const char *fedName, helics_error *err)
Definition: FederateExport.cpp:1169
void helicsBrokerAddDestinationFilterToEndpoint(helics_broker broker, const char *filter, const char *endpoint, helics_error *err)
Definition: helicsExport.cpp:578
void helicsFederateSetIntegerProperty(helics_federate fed, int intProperty, int propertyVal, helics_error *err)
Definition: FederateExport.cpp:1058
void helicsQuerySetOrdering(helics_query query, int32_t mode, helics_error *err)
Definition: helicsExport.cpp:1054
@ fed
special logging command for message coming from a fed
Definition: loggingHelper.hpp:32
const char * helicsGetBuildFlags(void)
Definition: helicsExport.cpp:33
void helicsFederateFree(helics_federate fed)
Definition: helicsExport.cpp:837
void helicsCoreAddDestinationFilterToEndpoint(helics_core core, const char *filter, const char *endpoint, helics_error *err)
Definition: helicsExport.cpp:618
void helicsClearSignalHandler()
Definition: helicsExport.cpp:79
void helicsBrokerSetLogFile(helics_broker broker, const char *logFileName, helics_error *err)
Definition: helicsExport.cpp:520
void helicsFederateDisconnectAsync(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:658
void helicsFederateInfoSetBrokerInitString(helics_federate_info fi, const char *brokerInit, helics_error *err)
Definition: FederateExport.cpp:223
const char * helicsQueryExecuteComplete(helics_query query, helics_error *err)
Definition: helicsExport.cpp:1008
helics_federate helicsGetFederateByName(const char *fedName, helics_error *err)
Definition: helicsExport.cpp:360
void helicsFederateFinalize(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:605
helics_bool helicsBrokerIsConnected(helics_broker broker)
Definition: helicsExport.cpp:468
helics_core helicsFederateGetCoreObject(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:541
void helicsAbort(int errorCode, const char *errorString)
Definition: helicsExport.cpp:877
void helicsFederateInfoSetBroker(helics_federate_info fi, const char *broker, helics_error *err)
Definition: FederateExport.cpp:267
void helicsFederateInfoSetCoreTypeFromString(helics_federate_info fi, const char *coretype, helics_error *err)
Definition: FederateExport.cpp:246
void helicsFederateInfoSetIntegerProperty(helics_federate_info fi, int intProperty, int propertyValue, helics_error *err)
Definition: FederateExport.cpp:372
void helicsFederateRequestTimeAsync(helics_federate fed, helics_time requestTime, helics_error *err)
Definition: FederateExport.cpp:915
Definition: api-data.h:166
helics_bool helicsFederateIsAsyncOperationCompleted(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:697
void helicsFederateSetGlobal(helics_federate fed, const char *valueName, const char *value, helics_error *err)
Definition: FederateExport.cpp:1148
void helicsCoreDataLink(helics_core core, const char *source, const char *target, helics_error *err)
Definition: helicsExport.cpp:492
void helicsFederateInfoSetCoreInitString(helics_federate_info fi, const char *coreInit, helics_error *err)
Definition: FederateExport.cpp:209
helics_time helicsFederateGetCurrentTime(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:1137
void helicsFederateDisconnectComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:663
void helicsFederateRegisterInterfaces(helics_federate fed, const char *file, helics_error *err)
Definition: FederateExport.cpp:557
void helicsCoreDestroy(helics_core core)
Definition: helicsExport.cpp:811
void helicsFederateRequestTimeIterativeAsync(helics_federate fed, helics_time requestTime, helics_iteration_request iterate, helics_error *err)
Definition: FederateExport.cpp:945
void helicsFederateLocalError(helics_federate fed, int errorCode, const char *errorString)
Definition: FederateExport.cpp:590
void helicsFederateInfoLoadFromArgs(helics_federate_info fi, int argc, const char *const *argv, helics_error *err)
Definition: FederateExport.cpp:176
void helicsQuerySetQueryString(helics_query query, const char *queryString, helics_error *err)
Definition: helicsExport.cpp:1045
void helicsBrokerClearTimeBarrier(helics_broker broker)
Definition: helicsExport.cpp:538
void * helics_federate_info
Definition: api-data.h:61
const char * helicsBrokerGetAddress(helics_broker broker)
Definition: helicsExport.cpp:697
helics_time helicsFederateRequestTimeAdvance(helics_federate fed, helics_time timeDelta, helics_error *err)
Definition: FederateExport.cpp:854
helics_time helicsFederateRequestNextStep(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:870
void helicsFederateInfoSetLocalPort(helics_federate_info fi, const char *localPort, helics_error *err)
Definition: FederateExport.cpp:304
void helicsFederateInfoSetTimeProperty(helics_federate_info fi, int timeProperty, helics_time propertyValue, helics_error *err)
Definition: FederateExport.cpp:354
void helicsFederateLogInfoMessage(helics_federate fed, const char *logmessage, helics_error *err)
Definition: FederateExport.cpp:1225
void helicsErrorClear(helics_error *err)
Definition: helicsExport.cpp:56
void helicsLoadSignalHandlerCallback(helics_bool(*handler)(int))
Definition: helicsExport.cpp:97
helics_broker helicsBrokerClone(helics_broker broker, helics_error *err)
Definition: helicsExport.cpp:445
helics_core helicsCoreClone(helics_core core, helics_error *err)
Definition: helicsExport.cpp:336
void helicsFederateSetLogFile(helics_federate fed, const char *logFile, helics_error *err)
Definition: FederateExport.cpp:1190
Data structures for the C api.
void helicsCoreFree(helics_core core)
Definition: helicsExport.cpp:817
void helicsFederateSetTimeProperty(helics_federate fed, int timeProperty, helics_time time, helics_error *err)
Definition: FederateExport.cpp:1028
void * helics_broker
Definition: api-data.h:51
void helicsBrokerDataLink(helics_broker broker, const char *source, const char *target, helics_error *err)
Definition: helicsExport.cpp:479
void helicsFederateLogErrorMessage(helics_federate fed, const char *logmessage, helics_error *err)
Definition: FederateExport.cpp:1215
void helicsBrokerDestroy(helics_broker broker)
Definition: helicsExport.cpp:805
void helicsFederateFinalizeAsync(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:621
void helicsCoreAddSourceFilterToEndpoint(helics_core core, const char *filter, const char *endpoint, helics_error *err)
Definition: helicsExport.cpp:605
int helics_bool
Definition: api-data.h:92
const char * helicsQueryBrokerExecute(helics_query query, helics_broker broker, helics_error *err)
Definition: helicsExport.cpp:959
helics_broker helicsCreateBroker(const char *type, const char *name, const char *initString, helics_error *err)
Definition: helicsExport.cpp:384
helics_time helicsFederateRequestTimeComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:929
helics_federate_state helicsFederateGetState(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:1000
void helicsFederateEnterExecutingMode(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:720
void helicsFederateEnterExecutingModeComplete(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:809
void helicsFederateEnterExecutingModeIterativeAsync(helics_federate fed, helics_iteration_request iterate, helics_error *err)
Definition: FederateExport.cpp:795
void helicsFederateInfoSetBrokerPort(helics_federate_info fi, int brokerPort, helics_error *err)
Definition: FederateExport.cpp:295
int helicsGetOptionValue(const char *val)
Definition: FederateExport.cpp:337
int helicsGetPropertyIndex(const char *val)
Definition: FederateExport.cpp:313
void helicsFederateInfoSetSeparator(helics_federate_info fi, char separator, helics_error *err)
Definition: FederateExport.cpp:363
helics_federate helicsCreateCombinationFederate(const char *fedName, helics_federate_info fi, helics_error *err)
Definition: FederateExport.cpp:474
helics_federate helicsCreateMessageFederate(const char *fedName, helics_federate_info fi, helics_error *err)
Definition: FederateExport.cpp:428
helics_query helicsCreateQuery(const char *target, const char *query)
Definition: helicsExport.cpp:906
void helicsQueryExecuteAsync(helics_query query, helics_federate fed, helics_error *err)
Definition: helicsExport.cpp:982
helics_bool helicsBrokerWaitForDisconnect(helics_broker broker, int msToWait, helics_error *err)
Definition: helicsExport.cpp:763
void * helics_federate
Definition: api-data.h:56
void helicsCoreSetReadyToInit(helics_core core, helics_error *err)
Definition: helicsExport.cpp:719
helics_iteration_result
Definition: api-data.h:109
helics_time helicsFederateRequestTimeIterativeComplete(helics_federate fed, helics_iteration_result *outIterate, helics_error *err)
Definition: FederateExport.cpp:962
void helicsFederateDisconnect(helics_federate fed, helics_error *err)
Definition: FederateExport.cpp:653