helics  3.0.1
helicsCore.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2017-2021,
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 
48 HELICS_EXPORT HelicsError helicsErrorInitialize(void);
49 
53 HELICS_EXPORT void helicsErrorClear(HelicsError* err);
54 
57 HELICS_EXPORT void helicsLoadSignalHandler();
58 
60 HELICS_EXPORT void helicsClearSignalHandler();
61 
69 HELICS_EXPORT void helicsLoadSignalHandlerCallback(HelicsBool (*handler)(int));
70 
73 HELICS_EXPORT void helicsAbort(int errorCode, const char* errorString);
74 
82 HELICS_EXPORT HelicsBool helicsIsCoreTypeAvailable(const char* type);
83 
100 HELICS_EXPORT HelicsCore helicsCreateCore(const char* type, const char* name, const char* initString, HelicsError* err);
101 
118 HELICS_EXPORT HelicsCore helicsCreateCoreFromArgs(const char* type, const char* name, int argc, const char* const* argv, HelicsError* err);
119 
132 HELICS_EXPORT HelicsCore helicsCoreClone(HelicsCore core, HelicsError* err);
133 
139 HELICS_EXPORT HelicsBool helicsCoreIsValid(HelicsCore core);
140 
158 HELICS_EXPORT HelicsBroker helicsCreateBroker(const char* type, const char* name, const char* initString, HelicsError* err);
159 
175 HELICS_EXPORT HelicsBroker
176  helicsCreateBrokerFromArgs(const char* type, const char* name, int argc, const char* const* argv, HelicsError* err);
177 
190 HELICS_EXPORT HelicsBroker helicsBrokerClone(HelicsBroker broker, HelicsError* err);
191 
197 HELICS_EXPORT HelicsBool helicsBrokerIsValid(HelicsBroker broker);
198 
206 HELICS_EXPORT HelicsBool helicsBrokerIsConnected(HelicsBroker broker);
207 
218 HELICS_EXPORT void helicsBrokerDataLink(HelicsBroker broker, const char* source, const char* target, HelicsError* err);
219 
230 HELICS_EXPORT void helicsBrokerAddSourceFilterToEndpoint(HelicsBroker broker, const char* filter, const char* endpoint, HelicsError* err);
231 
242 HELICS_EXPORT void
243  helicsBrokerAddDestinationFilterToEndpoint(HelicsBroker broker, const char* filter, const char* endpoint, HelicsError* err);
244 
254 HELICS_EXPORT void helicsBrokerMakeConnections(HelicsBroker broker, const char* file, HelicsError* err);
255 
267 HELICS_EXPORT HelicsBool helicsCoreWaitForDisconnect(HelicsCore core, int msToWait, HelicsError* err);
268 
280 HELICS_EXPORT HelicsBool helicsBrokerWaitForDisconnect(HelicsBroker broker, int msToWait, HelicsError* err);
281 
289 HELICS_EXPORT HelicsBool helicsCoreIsConnected(HelicsCore core);
290 
301 HELICS_EXPORT void helicsCoreDataLink(HelicsCore core, const char* source, const char* target, HelicsError* err);
302 
313 HELICS_EXPORT void helicsCoreAddSourceFilterToEndpoint(HelicsCore core, const char* filter, const char* endpoint, HelicsError* err);
314 
325 HELICS_EXPORT void helicsCoreAddDestinationFilterToEndpoint(HelicsCore core, const char* filter, const char* endpoint, HelicsError* err);
326 
336 HELICS_EXPORT void helicsCoreMakeConnections(HelicsCore core, const char* file, HelicsError* err);
337 
345 HELICS_EXPORT const char* helicsBrokerGetIdentifier(HelicsBroker broker);
346 
354 HELICS_EXPORT const char* helicsCoreGetIdentifier(HelicsCore core);
355 
363 HELICS_EXPORT const char* helicsBrokerGetAddress(HelicsBroker broker);
364 
372 HELICS_EXPORT const char* helicsCoreGetAddress(HelicsCore core);
373 
385 HELICS_EXPORT void helicsCoreSetReadyToInit(HelicsCore core, HelicsError* err);
386 
397 HELICS_EXPORT HelicsBool helicsCoreConnect(HelicsCore core, HelicsError* err);
398 
407 HELICS_EXPORT void helicsCoreDisconnect(HelicsCore core, HelicsError* err);
408 
422 HELICS_EXPORT HelicsFederate helicsGetFederateByName(const char* fedName, HelicsError* err);
423 
432 HELICS_EXPORT void helicsBrokerDisconnect(HelicsBroker broker, HelicsError* err);
433 
437 HELICS_EXPORT void helicsFederateDestroy(HelicsFederate fed);
438 
442 HELICS_EXPORT void helicsBrokerDestroy(HelicsBroker broker);
443 
447 HELICS_EXPORT void helicsCoreDestroy(HelicsCore core);
448 
452 HELICS_EXPORT void helicsCoreFree(HelicsCore core);
453 
457 HELICS_EXPORT void helicsBrokerFree(HelicsBroker broker);
458 
459 /*
460  * Creation and destruction of Federates.
461  */
462 
476 HELICS_EXPORT HelicsFederate helicsCreateValueFederate(const char* fedName, HelicsFederateInfo fi, HelicsError* err);
477 
490 HELICS_EXPORT HelicsFederate helicsCreateValueFederateFromConfig(const char* configFile, HelicsError* err);
491 
506 HELICS_EXPORT HelicsFederate helicsCreateMessageFederate(const char* fedName, HelicsFederateInfo fi, HelicsError* err);
507 
521 HELICS_EXPORT HelicsFederate helicsCreateMessageFederateFromConfig(const char* configFile, HelicsError* err);
522 
537 HELICS_EXPORT HelicsFederate helicsCreateCombinationFederate(const char* fedName, HelicsFederateInfo fi, HelicsError* err);
538 
552 HELICS_EXPORT HelicsFederate helicsCreateCombinationFederateFromConfig(const char* configFile, HelicsError* err);
553 
567 
573 HELICS_EXPORT HelicsFederateInfo helicsCreateFederateInfo(void);
574 
586 
597 HELICS_EXPORT void helicsFederateInfoLoadFromArgs(HelicsFederateInfo fi, int argc, const char* const* argv, HelicsError* err);
598 
602 HELICS_EXPORT void helicsFederateInfoFree(HelicsFederateInfo fi);
603 
610 
620 HELICS_EXPORT void helicsFederateInfoSetCoreName(HelicsFederateInfo fi, const char* corename, HelicsError* err);
621 
631 HELICS_EXPORT void helicsFederateInfoSetCoreInitString(HelicsFederateInfo fi, const char* coreInit, HelicsError* err);
632 
642 HELICS_EXPORT void helicsFederateInfoSetBrokerInitString(HelicsFederateInfo fi, const char* brokerInit, HelicsError* err);
643 
654 HELICS_EXPORT void helicsFederateInfoSetCoreType(HelicsFederateInfo fi, int coretype, HelicsError* err);
655 
665 HELICS_EXPORT void helicsFederateInfoSetCoreTypeFromString(HelicsFederateInfo fi, const char* coretype, HelicsError* err);
666 
677 HELICS_EXPORT void helicsFederateInfoSetBroker(HelicsFederateInfo fi, const char* broker, HelicsError* err);
678 
689 HELICS_EXPORT void helicsFederateInfoSetBrokerKey(HelicsFederateInfo fi, const char* brokerkey, HelicsError* err);
690 
702 HELICS_EXPORT void helicsFederateInfoSetBrokerPort(HelicsFederateInfo fi, int brokerPort, HelicsError* err);
703 
714 HELICS_EXPORT void helicsFederateInfoSetLocalPort(HelicsFederateInfo fi, const char* localPort, HelicsError* err);
715 
722 HELICS_EXPORT int helicsGetPropertyIndex(const char* val);
723 
729 HELICS_EXPORT int helicsGetFlagIndex(const char* val);
730 
739 HELICS_EXPORT int helicsGetOptionIndex(const char* val);
740 
749 HELICS_EXPORT int helicsGetOptionValue(const char* val);
750 
759 HELICS_EXPORT int helicsGetDataType(const char* val);
760 
771 HELICS_EXPORT void helicsFederateInfoSetFlagOption(HelicsFederateInfo fi, int flag, HelicsBool value, HelicsError* err);
772 
783 HELICS_EXPORT void helicsFederateInfoSetSeparator(HelicsFederateInfo fi, char separator, HelicsError* err);
784 
794 HELICS_EXPORT void helicsFederateInfoSetTimeProperty(HelicsFederateInfo fi, int timeProperty, HelicsTime propertyValue, HelicsError* err);
795 
796 // TODO(Dheepak): what are known properties. The docstring should reference all properties that can be passed here.
808 HELICS_EXPORT void helicsFederateInfoSetIntegerProperty(HelicsFederateInfo fi, int intProperty, int propertyValue, HelicsError* err);
809 
818 HELICS_EXPORT void helicsFederateRegisterInterfaces(HelicsFederate fed, const char* file, HelicsError* err);
819 
830 HELICS_EXPORT void helicsFederateGlobalError(HelicsFederate fed, int errorCode, const char* errorString, HelicsError* err);
831 
842 HELICS_EXPORT void helicsFederateLocalError(HelicsFederate fed, int errorCode, const char* errorString, HelicsError* err);
843 
847 HELICS_EXPORT void helicsFederateFinalize(HelicsFederate fed, HelicsError* err);
848 
852 HELICS_EXPORT void helicsFederateFinalizeAsync(HelicsFederate fed, HelicsError* err);
853 
857 HELICS_EXPORT void helicsFederateFinalizeComplete(HelicsFederate fed, HelicsError* err);
858 
863 HELICS_EXPORT void helicsFederateDisconnect(HelicsFederate fed, HelicsError* err);
864 
868 HELICS_EXPORT void helicsFederateDisconnectAsync(HelicsFederate fed, HelicsError* err);
869 
873 HELICS_EXPORT void helicsFederateDisconnectComplete(HelicsFederate fed, HelicsError* err);
874 
878 HELICS_EXPORT void helicsFederateFree(HelicsFederate fed);
879 
884 HELICS_EXPORT void helicsCloseLibrary(void);
885 
886 /*
887  * Initialization, execution, and time requests.
888  */
889 
901 
912 
923 
932 
943 HELICS_EXPORT void helicsFederateEnterExecutingMode(HelicsFederate fed, HelicsError* err);
944 
956 
965 
980  HelicsIterationRequest iterate,
981  HelicsError* err);
982 
995 
1006 
1017 
1028 
1039 HELICS_EXPORT HelicsTime helicsFederateRequestTime(HelicsFederate fed, HelicsTime requestTime, HelicsError* err);
1040 
1052 
1066 
1084  HelicsTime requestTime,
1085  HelicsIterationRequest iterate,
1086  HelicsIterationResult* outIteration,
1087  HelicsError* err);
1088 
1099 HELICS_EXPORT void helicsFederateRequestTimeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsError* err);
1100 
1111 
1124 HELICS_EXPORT void
1126 
1138  HelicsIterationResult* outIterate,
1139  HelicsError* err);
1140 
1148 HELICS_EXPORT const char* helicsFederateGetName(HelicsFederate fed);
1149 
1159 HELICS_EXPORT void helicsFederateSetTimeProperty(HelicsFederate fed, int timeProperty, HelicsTime time, HelicsError* err);
1160 
1170 HELICS_EXPORT void helicsFederateSetFlagOption(HelicsFederate fed, int flag, HelicsBool flagValue, HelicsError* err);
1171 
1183 HELICS_EXPORT void helicsFederateSetSeparator(HelicsFederate fed, char separator, HelicsError* err);
1184 
1194 HELICS_EXPORT void helicsFederateSetIntegerProperty(HelicsFederate fed, int intProperty, int propertyVal, HelicsError* err);
1195 
1204 HELICS_EXPORT HelicsTime helicsFederateGetTimeProperty(HelicsFederate fed, int timeProperty, HelicsError* err);
1205 
1216 HELICS_EXPORT HelicsBool helicsFederateGetFlagOption(HelicsFederate fed, int flag, HelicsError* err);
1217 
1228 HELICS_EXPORT int helicsFederateGetIntegerProperty(HelicsFederate fed, int intProperty, HelicsError* err);
1229 
1240 
1251 HELICS_EXPORT void helicsFederateSetGlobal(HelicsFederate fed, const char* valueName, const char* value, HelicsError* err);
1252 
1263 HELICS_EXPORT void helicsFederateSetTag(HelicsFederate fed, const char* tagName, const char* value, HelicsError* err);
1264 
1273 HELICS_EXPORT const char* helicsFederateGetTag(HelicsFederate fed, const char* tagName, HelicsError* err);
1274 
1283 HELICS_EXPORT void helicsFederateAddDependency(HelicsFederate fed, const char* fedName, HelicsError* err);
1284 
1293 HELICS_EXPORT void helicsFederateSetLogFile(HelicsFederate fed, const char* logFile, HelicsError* err);
1294 
1303 HELICS_EXPORT void helicsFederateLogErrorMessage(HelicsFederate fed, const char* logmessage, HelicsError* err);
1304 
1313 HELICS_EXPORT void helicsFederateLogWarningMessage(HelicsFederate fed, const char* logmessage, HelicsError* err);
1314 
1323 HELICS_EXPORT void helicsFederateLogInfoMessage(HelicsFederate fed, const char* logmessage, HelicsError* err);
1324 
1333 HELICS_EXPORT void helicsFederateLogDebugMessage(HelicsFederate fed, const char* logmessage, HelicsError* err);
1334 
1344 HELICS_EXPORT void helicsFederateLogLevelMessage(HelicsFederate fed, int loglevel, const char* logmessage, HelicsError* err);
1345 
1355 HELICS_EXPORT void helicsFederateSendCommand(HelicsFederate fed, const char* target, const char* command, HelicsError* err);
1356 
1366 HELICS_EXPORT const char* helicsFederateGetCommand(HelicsFederate fed, HelicsError* err);
1367 
1377 HELICS_EXPORT const char* helicsFederateGetCommandSource(HelicsFederate fed, HelicsError* err);
1378 
1388 HELICS_EXPORT const char* helicsFederateWaitCommand(HelicsFederate fed, HelicsError* err);
1400 HELICS_EXPORT void helicsCoreSetGlobal(HelicsCore core, const char* valueName, const char* value, HelicsError* err);
1401 
1413 HELICS_EXPORT void helicsBrokerSetGlobal(HelicsBroker broker, const char* valueName, const char* value, HelicsError* err);
1414 
1424 HELICS_EXPORT void helicsCoreSendCommand(HelicsCore core, const char* target, const char* command, HelicsError* err);
1425 
1435 HELICS_EXPORT void helicsBrokerSendCommand(HelicsBroker broker, const char* target, const char* command, HelicsError* err);
1436 
1445 HELICS_EXPORT void helicsCoreSetLogFile(HelicsCore core, const char* logFileName, HelicsError* err);
1446 
1455 HELICS_EXPORT void helicsBrokerSetLogFile(HelicsBroker broker, const char* logFileName, HelicsError* err);
1456 
1465 HELICS_EXPORT void helicsBrokerSetTimeBarrier(HelicsBroker broker, HelicsTime barrierTime, HelicsError* err);
1466 
1472 HELICS_EXPORT void helicsBrokerClearTimeBarrier(HelicsBroker broker);
1473 
1483 HELICS_EXPORT void helicsBrokerGlobalError(HelicsBroker broker, int errorCode, const char* errorString, HelicsError* err);
1484 
1494 HELICS_EXPORT void helicsCoreGlobalError(HelicsCore core, int errorCode, const char* errorString, HelicsError* err);
1503 HELICS_EXPORT HelicsQuery helicsCreateQuery(const char* target, const char* query);
1504 
1521 HELICS_EXPORT const char* helicsQueryExecute(HelicsQuery query, HelicsFederate fed, HelicsError* err);
1522 
1538 HELICS_EXPORT const char* helicsQueryCoreExecute(HelicsQuery query, HelicsCore core, HelicsError* err);
1539 
1555 HELICS_EXPORT const char* helicsQueryBrokerExecute(HelicsQuery query, HelicsBroker broker, HelicsError* err);
1556 
1565 HELICS_EXPORT void helicsQueryExecuteAsync(HelicsQuery query, HelicsFederate fed, HelicsError* err);
1566 
1581 HELICS_EXPORT const char* helicsQueryExecuteComplete(HelicsQuery query, HelicsError* err);
1582 
1593 HELICS_EXPORT HelicsBool helicsQueryIsCompleted(HelicsQuery query);
1594 
1604 HELICS_EXPORT void helicsQuerySetTarget(HelicsQuery query, const char* target, HelicsError* err);
1605 
1614 HELICS_EXPORT void helicsQuerySetQueryString(HelicsQuery query, const char* queryString, HelicsError* err);
1615 
1625 HELICS_EXPORT void helicsQuerySetOrdering(HelicsQuery query, int32_t mode, HelicsError* err);
1626 
1630 HELICS_EXPORT void helicsQueryFree(HelicsQuery query);
1631 
1637 HELICS_EXPORT void helicsCleanupLibrary(void);
1638 
1639 #ifdef __cplusplus
1640 } /* end of extern "C" { */
1641 #endif
1642 
1643 #endif
helicsFederateInfoLoadFromArgs
void helicsFederateInfoLoadFromArgs(HelicsFederateInfo fi, int argc, const char *const *argv, HelicsError *err)
Definition: FederateExport.cpp:176
helicsFederateSetTag
void helicsFederateSetTag(HelicsFederate fed, const char *tagName, const char *value, HelicsError *err)
Definition: FederateExport.cpp:1190
helicsCoreSendCommand
void helicsCoreSendCommand(HelicsCore core, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:685
helicsFederateSetGlobal
void helicsFederateSetGlobal(HelicsFederate fed, const char *valueName, const char *value, HelicsError *err)
Definition: FederateExport.cpp:1169
helicsQuerySetTarget
void helicsQuerySetTarget(HelicsQuery query, const char *target, HelicsError *err)
Definition: helicsExport.cpp:1072
HelicsTime
double HelicsTime
Definition: api-data.h:90
helicsCoreClone
HelicsCore helicsCoreClone(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:336
helicsGetBuildFlags
const char * helicsGetBuildFlags(void)
Definition: helicsExport.cpp:34
helicsQueryCoreExecute
const char * helicsQueryCoreExecute(HelicsQuery query, HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:973
helicsCoreFree
void helicsCoreFree(HelicsCore core)
Definition: helicsExport.cpp:853
helicsFederateSetFlagOption
void helicsFederateSetFlagOption(HelicsFederate fed, int flag, HelicsBool flagValue, HelicsError *err)
Definition: FederateExport.cpp:1063
helicsFederateGetCurrentTime
HelicsTime helicsFederateGetCurrentTime(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1158
helicsFederateInfoSetBroker
void helicsFederateInfoSetBroker(HelicsFederateInfo fi, const char *broker, HelicsError *err)
Definition: FederateExport.cpp:267
helicsCreateValueFederateFromConfig
HelicsFederate helicsCreateValueFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:431
helicsLoadSignalHandlerCallback
void helicsLoadSignalHandlerCallback(HelicsBool(*handler)(int))
Definition: helicsExport.cpp:97
helicsFederateRequestTimeComplete
HelicsTime helicsFederateRequestTimeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:953
helicsFederateRequestTimeAdvance
HelicsTime helicsFederateRequestTimeAdvance(HelicsFederate fed, HelicsTime timeDelta, HelicsError *err)
Definition: FederateExport.cpp:878
helicsFederateEnterExecutingModeAsync
void helicsFederateEnterExecutingModeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:805
helicsGetOptionValue
int helicsGetOptionValue(const char *val)
Definition: FederateExport.cpp:337
helicsQuerySetOrdering
void helicsQuerySetOrdering(HelicsQuery query, int32_t mode, HelicsError *err)
Definition: helicsExport.cpp:1090
helicsErrorClear
void helicsErrorClear(HelicsError *err)
Definition: helicsExport.cpp:57
helicsFederateDestroy
void helicsFederateDestroy(HelicsFederate fed)
Definition: helicsExport.cpp:835
helicsBrokerSetTimeBarrier
void helicsBrokerSetTimeBarrier(HelicsBroker broker, HelicsTime barrierTime, HelicsError *err)
Definition: helicsExport.cpp:547
helicsCoreDestroy
void helicsCoreDestroy(HelicsCore core)
Definition: helicsExport.cpp:847
helicsFederateIsValid
HelicsBool helicsFederateIsValid(HelicsFederate fed)
Definition: FederateExport.cpp:557
helicsFederateEnterExecutingModeIterative
HelicsIterationResult helicsFederateEnterExecutingModeIterative(HelicsFederate fed, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:789
helicsFederateAddDependency
void helicsFederateAddDependency(HelicsFederate fed, const char *fedName, HelicsError *err)
Definition: FederateExport.cpp:1233
helicsFederateEnterExecutingMode
void helicsFederateEnterExecutingMode(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:744
helicsBrokerClone
HelicsBroker helicsBrokerClone(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:445
helicsFederateEnterExecutingModeIterativeAsync
void helicsFederateEnterExecutingModeIterativeAsync(HelicsFederate fed, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:819
helicsFederateLocalError
void helicsFederateLocalError(HelicsFederate fed, int errorCode, const char *errorString, HelicsError *err)
Definition: FederateExport.cpp:613
helicsBrokerIsConnected
HelicsBool helicsBrokerIsConnected(HelicsBroker broker)
Definition: helicsExport.cpp:468
HelicsFederate
void * HelicsFederate
Definition: api-data.h:60
helicsFederateIsAsyncOperationCompleted
HelicsBool helicsFederateIsAsyncOperationCompleted(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:721
helicsQueryExecuteComplete
const char * helicsQueryExecuteComplete(HelicsQuery query, HelicsError *err)
Definition: helicsExport.cpp:1044
helicsFederateRegisterInterfaces
void helicsFederateRegisterInterfaces(HelicsFederate fed, const char *file, HelicsError *err)
Definition: FederateExport.cpp:579
helicsQueryExecuteAsync
void helicsQueryExecuteAsync(HelicsQuery query, HelicsFederate fed, HelicsError *err)
Definition: helicsExport.cpp:1018
helicsCoreSetGlobal
void helicsCoreSetGlobal(HelicsCore core, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:672
helicsCreateMessageFederateFromConfig
HelicsFederate helicsCreateMessageFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:476
helicsFederateFinalize
void helicsFederateFinalize(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:629
helicsCreateCombinationFederateFromConfig
HelicsFederate helicsCreateCombinationFederateFromConfig(const char *configFile, HelicsError *err)
Definition: FederateExport.cpp:522
helicsGetOptionIndex
int helicsGetOptionIndex(const char *val)
Definition: FederateExport.cpp:329
helicsFederateSendCommand
void helicsFederateSendCommand(HelicsFederate fed, const char *target, const char *command, HelicsError *err)
Definition: FederateExport.cpp:1308
helicsFederateSetSeparator
void helicsFederateSetSeparator(HelicsFederate fed, char separator, HelicsError *err)
Definition: FederateExport.cpp:1149
helicsCoreDataLink
void helicsCoreDataLink(HelicsCore core, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:492
helicsQueryExecute
const char * helicsQueryExecute(HelicsQuery query, HelicsFederate fed, HelicsError *err)
Definition: helicsExport.cpp:953
helicsFederateClone
HelicsFederate helicsFederateClone(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:541
helicsCreateCore
HelicsCore helicsCreateCore(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:266
helicsFederateEnterExecutingModeComplete
void helicsFederateEnterExecutingModeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:833
helicsQueryFree
void helicsQueryFree(HelicsQuery query)
Definition: helicsExport.cpp:1099
helicsFederateGlobalError
void helicsFederateGlobalError(HelicsFederate fed, int errorCode, const char *errorString, HelicsError *err)
Definition: FederateExport.cpp:597
helicsFederateLogWarningMessage
void helicsFederateLogWarningMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1284
helicsIsCoreTypeAvailable
HelicsBool helicsIsCoreTypeAvailable(const char *type)
Definition: helicsExport.cpp:107
helicsBrokerSendCommand
void helicsBrokerSendCommand(HelicsBroker broker, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:520
helicsFederateGetState
HelicsFederateState helicsFederateGetState(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1021
helicsCoreGetIdentifier
const char * helicsCoreGetIdentifier(HelicsCore core)
Definition: helicsExport.cpp:722
helicsFederateGetCommand
const char * helicsFederateGetCommand(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1317
helicsFederateRequestTime
HelicsTime helicsFederateRequestTime(HelicsFederate fed, HelicsTime requestTime, HelicsError *err)
Definition: FederateExport.cpp:862
helicsFederateSetIntegerProperty
void helicsFederateSetIntegerProperty(HelicsFederate fed, int intProperty, int propertyVal, HelicsError *err)
Definition: FederateExport.cpp:1079
helicsBrokerFree
void helicsBrokerFree(HelicsBroker broker)
Definition: helicsExport.cpp:863
helicsBrokerGetIdentifier
const char * helicsBrokerGetIdentifier(HelicsBroker broker)
Definition: helicsExport.cpp:712
helicsFederateDisconnectAsync
void helicsFederateDisconnectAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:660
helicsBrokerDisconnect
void helicsBrokerDisconnect(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:819
helicsFederateSetTimeProperty
void helicsFederateSetTimeProperty(HelicsFederate fed, int timeProperty, HelicsTime time, HelicsError *err)
Definition: FederateExport.cpp:1049
helicsCreateCoreFromArgs
HelicsCore helicsCreateCoreFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:301
helicsErrorInitialize
HelicsError helicsErrorInitialize(void)
Definition: helicsExport.cpp:48
helicsFederateInfoSetTimeProperty
void helicsFederateInfoSetTimeProperty(HelicsFederateInfo fi, int timeProperty, HelicsTime propertyValue, HelicsError *err)
Definition: FederateExport.cpp:376
helicsBrokerClearTimeBarrier
void helicsBrokerClearTimeBarrier(HelicsBroker broker)
Definition: helicsExport.cpp:556
helicsGetCompilerVersion
const char * helicsGetCompilerVersion(void)
Definition: helicsExport.cpp:39
helicsFederateRequestNextStep
HelicsTime helicsFederateRequestNextStep(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:894
helicsCreateFederateInfo
HelicsFederateInfo helicsCreateFederateInfo(void)
Definition: FederateExport.cpp:129
helicsFederateSetLogFile
void helicsFederateSetLogFile(HelicsFederate fed, const char *logFile, HelicsError *err)
Definition: FederateExport.cpp:1254
HelicsFederateInfo
void * HelicsFederateInfo
Definition: api-data.h:66
helicsCloseLibrary
void helicsCloseLibrary(void)
Definition: helicsExport.cpp:902
helicsFederateGetName
const char * helicsFederateGetName(HelicsFederate fed)
Definition: FederateExport.cpp:1039
helicsCreateMessageFederate
HelicsFederate helicsCreateMessageFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:450
HelicsBroker
void * HelicsBroker
Definition: api-data.h:55
helicsCoreGlobalError
void helicsCoreGlobalError(HelicsCore core, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:574
helicsQueryIsCompleted
HelicsBool helicsQueryIsCompleted(HelicsQuery query)
Definition: helicsExport.cpp:1059
helicsFederateInfoFree
void helicsFederateInfoFree(HelicsFederateInfo fi)
Definition: FederateExport.cpp:165
helicsCleanupLibrary
void helicsCleanupLibrary(void)
Definition: helicsExport.cpp:1110
helicsFederateInfoSetFlagOption
void helicsFederateInfoSetFlagOption(HelicsFederateInfo fi, int flag, HelicsBool value, HelicsError *err)
Definition: FederateExport.cpp:353
helicsFederateEnterInitializingModeAsync
void helicsFederateEnterInitializingModeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:707
helicsCreateBrokerFromArgs
HelicsBroker helicsCreateBrokerFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:412
helicsFederateInfoSetCoreInitString
void helicsFederateInfoSetCoreInitString(HelicsFederateInfo fi, const char *coreInit, HelicsError *err)
Definition: FederateExport.cpp:209
helicsFederateInfoSetCoreName
void helicsFederateInfoSetCoreName(HelicsFederateInfo fi, const char *corename, HelicsError *err)
Definition: FederateExport.cpp:195
helicsFederateGetIntegerProperty
int helicsFederateGetIntegerProperty(HelicsFederate fed, int intProperty, HelicsError *err)
Definition: FederateExport.cpp:1132
helicsFederateRequestTimeIterative
HelicsTime helicsFederateRequestTimeIterative(HelicsFederate fed, HelicsTime requestTime, HelicsIterationRequest iterate, HelicsIterationResult *outIteration, HelicsError *err)
Definition: FederateExport.cpp:910
helicsGetFlagIndex
int helicsGetFlagIndex(const char *val)
Definition: FederateExport.cpp:321
helicsFederateLogDebugMessage
void helicsFederateLogDebugMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1294
helicsCoreDisconnect
void helicsCoreDisconnect(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:782
helicsFederateLogInfoMessage
void helicsFederateLogInfoMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1289
helicsFederateLogLevelMessage
void helicsFederateLogLevelMessage(HelicsFederate fed, int loglevel, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1299
helicsCoreConnect
HelicsBool helicsCoreConnect(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:764
helicsFederateInfoSetCoreTypeFromString
void helicsFederateInfoSetCoreTypeFromString(HelicsFederateInfo fi, const char *coretype, HelicsError *err)
Definition: FederateExport.cpp:246
helicsFederateGetCommandSource
const char * helicsFederateGetCommandSource(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1332
helicsFederateInfoSetLocalPort
void helicsFederateInfoSetLocalPort(HelicsFederateInfo fi, const char *localPort, HelicsError *err)
Definition: FederateExport.cpp:304
helicsFederateFinalizeComplete
void helicsFederateFinalizeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:639
helicsFederateDisconnect
void helicsFederateDisconnect(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:644
helicsBrokerIsValid
HelicsBool helicsBrokerIsValid(HelicsBroker broker)
Definition: helicsExport.cpp:459
helicsFederateGetTag
const char * helicsFederateGetTag(HelicsFederate fed, const char *tagName, HelicsError *err)
Definition: FederateExport.cpp:1210
helicsQuerySetQueryString
void helicsQuerySetQueryString(HelicsQuery query, const char *queryString, HelicsError *err)
Definition: helicsExport.cpp:1081
helicsBrokerMakeConnections
void helicsBrokerMakeConnections(HelicsBroker broker, const char *file, HelicsError *err)
Definition: helicsExport.cpp:609
HelicsFederateState
HelicsFederateState
Definition: api-data.h:129
helicsCreateBroker
HelicsBroker helicsCreateBroker(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:384
helicsBrokerAddDestinationFilterToEndpoint
void helicsBrokerAddDestinationFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:596
HelicsError
Definition: api-data.h:160
HelicsIterationResult
HelicsIterationResult
Definition: api-data.h:119
helicsCreateCombinationFederate
HelicsFederate helicsCreateCombinationFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:496
helicsClearSignalHandler
void helicsClearSignalHandler()
Definition: helicsExport.cpp:79
helicsBrokerSetLogFile
void helicsBrokerSetLogFile(HelicsBroker broker, const char *logFileName, HelicsError *err)
Definition: helicsExport.cpp:538
helicsFederateGetFlagOption
HelicsBool helicsFederateGetFlagOption(HelicsFederate fed, int flag, HelicsError *err)
Definition: FederateExport.cpp:1114
helicsCoreAddSourceFilterToEndpoint
void helicsCoreAddSourceFilterToEndpoint(HelicsCore core, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:623
helicsAbort
void helicsAbort(int errorCode, const char *errorString)
Definition: helicsExport.cpp:913
HelicsCore
void * HelicsCore
Definition: api-data.h:49
helicsQueryBrokerExecute
const char * helicsQueryBrokerExecute(HelicsQuery query, HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:995
helicsCoreSetReadyToInit
void helicsCoreSetReadyToInit(HelicsCore core, HelicsError *err)
Definition: helicsExport.cpp:755
helicsFederateRequestTimeIterativeComplete
HelicsTime helicsFederateRequestTimeIterativeComplete(HelicsFederate fed, HelicsIterationResult *outIterate, HelicsError *err)
Definition: FederateExport.cpp:983
helicsGetVersion
const char * helicsGetVersion(void)
Definition: helicsExport.cpp:29
helicsFederateFinalizeAsync
void helicsFederateFinalizeAsync(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:634
helicsFederateInfoSetBrokerKey
void helicsFederateInfoSetBrokerKey(HelicsFederateInfo fi, const char *brokerkey, HelicsError *err)
Definition: FederateExport.cpp:281
helicsFederateFree
void helicsFederateFree(HelicsFederate fed)
Definition: helicsExport.cpp:873
helicsBrokerAddSourceFilterToEndpoint
void helicsBrokerAddSourceFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:583
helicsFederateRequestTimeAsync
void helicsFederateRequestTimeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsError *err)
Definition: FederateExport.cpp:939
helicsFederateInfoSetBrokerInitString
void helicsFederateInfoSetBrokerInitString(HelicsFederateInfo fi, const char *brokerInit, HelicsError *err)
Definition: FederateExport.cpp:223
helicsFederateEnterInitializingMode
void helicsFederateEnterInitializingMode(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:693
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:636
helicsFederateGetTimeProperty
HelicsTime helicsFederateGetTimeProperty(HelicsFederate fed, int timeProperty, HelicsError *err)
Definition: FederateExport.cpp:1095
helicsBrokerWaitForDisconnect
HelicsBool helicsBrokerWaitForDisconnect(HelicsBroker broker, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:799
helicsGetDataType
int helicsGetDataType(const char *val)
Definition: FederateExport.cpp:345
helicsFederateInfoSetIntegerProperty
void helicsFederateInfoSetIntegerProperty(HelicsFederateInfo fi, int intProperty, int propertyValue, HelicsError *err)
Definition: FederateExport.cpp:394
helicsCreateQuery
HelicsQuery helicsCreateQuery(const char *target, const char *query)
Definition: helicsExport.cpp:942
helicsFederateEnterInitializingModeComplete
void helicsFederateEnterInitializingModeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:730
helicsCreateValueFederate
HelicsFederate helicsCreateValueFederate(const char *fedName, HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:404
helicsBrokerSetGlobal
void helicsBrokerSetGlobal(HelicsBroker broker, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:507
helicsBrokerGlobalError
void helicsBrokerGlobalError(HelicsBroker broker, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:565
helicsFederateLogErrorMessage
void helicsFederateLogErrorMessage(HelicsFederate fed, const char *logmessage, HelicsError *err)
Definition: FederateExport.cpp:1279
helicsLoadSignalHandler
void helicsLoadSignalHandler()
Definition: helicsExport.cpp:74
helicsFederateWaitCommand
const char * helicsFederateWaitCommand(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:1342
HelicsQuery
void * HelicsQuery
Definition: api-data.h:72
helicsCoreIsConnected
HelicsBool helicsCoreIsConnected(HelicsCore core)
Definition: helicsExport.cpp:663
helicsFederateInfoSetBrokerPort
void helicsFederateInfoSetBrokerPort(HelicsFederateInfo fi, int brokerPort, HelicsError *err)
Definition: FederateExport.cpp:295
helicsBrokerGetAddress
const char * helicsBrokerGetAddress(HelicsBroker broker)
Definition: helicsExport.cpp:733
helicsGetPropertyIndex
int helicsGetPropertyIndex(const char *val)
Definition: FederateExport.cpp:313
helicsFederateInfoClone
HelicsFederateInfo helicsFederateInfoClone(HelicsFederateInfo fi, HelicsError *err)
Definition: FederateExport.cpp:155
helicsFederateEnterExecutingModeIterativeComplete
HelicsIterationResult helicsFederateEnterExecutingModeIterativeComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:846
helicsFederateInfoSetSeparator
void helicsFederateInfoSetSeparator(HelicsFederateInfo fi, char separator, HelicsError *err)
Definition: FederateExport.cpp:385
helicsCoreGetAddress
const char * helicsCoreGetAddress(HelicsCore core)
Definition: helicsExport.cpp:744
helicsCoreMakeConnections
void helicsCoreMakeConnections(HelicsCore core, const char *file, HelicsError *err)
Definition: helicsExport.cpp:649
helicsCoreIsValid
HelicsBool helicsCoreIsValid(HelicsCore core)
Definition: helicsExport.cpp:351
helicsFederateGetCore
HelicsCore helicsFederateGetCore(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:563
helicsCoreSetLogFile
void helicsCoreSetLogFile(HelicsCore core, const char *logFileName, HelicsError *err)
Definition: helicsExport.cpp:703
helicsGetFederateByName
HelicsFederate helicsGetFederateByName(const char *fedName, HelicsError *err)
Definition: helicsExport.cpp:360
helicsCoreWaitForDisconnect
HelicsBool helicsCoreWaitForDisconnect(HelicsCore core, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:809
helicsBrokerDestroy
void helicsBrokerDestroy(HelicsBroker broker)
Definition: helicsExport.cpp:841
HelicsBool
int HelicsBool
Definition: api-data.h:102
HelicsIterationRequest
HelicsIterationRequest
Definition: api-data.h:110
helicsFederateInfoSetCoreType
void helicsFederateInfoSetCoreType(HelicsFederateInfo fi, int coretype, HelicsError *err)
Definition: FederateExport.cpp:237
helicsBrokerDataLink
void helicsBrokerDataLink(HelicsBroker broker, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:479
helicsFederateRequestTimeIterativeAsync
void helicsFederateRequestTimeIterativeAsync(HelicsFederate fed, HelicsTime requestTime, HelicsIterationRequest iterate, HelicsError *err)
Definition: FederateExport.cpp:969
helicsFederateDisconnectComplete
void helicsFederateDisconnectComplete(HelicsFederate fed, HelicsError *err)
Definition: FederateExport.cpp:676