 |
helics
3.3.0
|
Go to the documentation of this file.
13 #ifndef HELICS_APISHARED_MESSAGE_FEDERATE_FUNCTIONS_H_
14 #define HELICS_APISHARED_MESSAGE_FEDERATE_FUNCTIONS_H_
const char * helicsMessageGetSource(HelicsMessage message)
Definition: MessageFederateExport.cpp:832
void helicsMessageCopy(HelicsMessage src_message, HelicsMessage dst_message, HelicsError *err)
Definition: MessageFederateExport.cpp:1104
Common functions for the HELICS C api.
void helicsEndpointSetTag(HelicsEndpoint endpoint, const char *tagname, const char *tagvalue, HelicsError *err)
Definition: MessageFederateExport.cpp:658
double HelicsTime
Definition: api-data.h:100
void helicsEndpointClearMessages(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:536
virtual void disconnect() override
Definition: MessageFederate.cpp:84
void helicsEndpointAddDestinationTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:722
void helicsEndpointSendBytes(HelicsEndpoint endpoint, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:221
HelicsEndpoint helicsFederateRegisterEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:47
const char * helicsMessageGetOriginalDestination(HelicsMessage message)
Definition: MessageFederateExport.cpp:859
void subscribe(std::string_view key)
Definition: Endpoints.cpp:133
void helicsMessageClearFlags(HelicsMessage message)
Definition: MessageFederateExport.cpp:1040
std::unique_ptr< Message > getMessage()
Definition: MessageFederate.cpp:273
FederateInfo loadFederateInfo(const std::string &configString)
Definition: FederateInfo.cpp:711
void helicsMessageSetMessageID(HelicsMessage message, int32_t messageID, HelicsError *err)
Definition: MessageFederateExport.cpp:1031
int helicsEndpointPendingMessageCount(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:382
void registerMessageInterfaces(const std::string &configString)
Definition: MessageFederate.cpp:136
void registerFilterInterfaces(const std::string &configString)
Definition: Federate.cpp:951
void * helicsMessageGetBytesPointer(HelicsMessage message)
Definition: MessageFederateExport.cpp:943
HelicsMessage helicsFederateCreateMessage(HelicsFederate fed, HelicsError *err)
Definition: MessageFederateExport.cpp:506
const char * helicsMessageGetOriginalSource(HelicsMessage message)
Definition: MessageFederateExport.cpp:850
void helicsEndpointSendMessageZeroCopy(HelicsEndpoint endpoint, HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:318
void helicsEndpointSetOption(HelicsEndpoint endpoint, int option, int value, HelicsError *err)
Definition: MessageFederateExport.cpp:690
void * HelicsFederate
Definition: api-data.h:65
std::string localNameGenerator(std::string_view addition) const
Definition: Federate.cpp:1441
int helicsMessageGetByteCount(HelicsMessage message)
Definition: MessageFederateExport.cpp:910
HelicsBool helicsEndpointIsValid(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:185
std::atomic< Modes > currentMode
the current state of the simulation
Definition: application_api/Federate.hpp:78
void subscribe(const Endpoint &ept, std::string_view key)
Definition: MessageFederate.cpp:236
TimeRepresentation< count_time< 9 > > Time
Definition: helicsTime.hpp:27
HelicsEndpoint helicsFederateGetEndpointByIndex(HelicsFederate fed, int index, HelicsError *err)
Definition: MessageFederateExport.cpp:159
void helicsMessageSetTime(HelicsMessage message, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:994
Definition: Endpoints.hpp:21
void logWarningMessage(std::string_view message) const
Definition: application_api/Federate.hpp:728
HelicsMessage helicsMessageClone(HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:1124
void helicsEndpointAddSourceTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:706
HelicsBool helicsMessageGetFlagOption(HelicsMessage message, int flag)
Definition: MessageFederateExport.cpp:886
Definition: application_api/MessageFederate.hpp:22
void helicsFederateClearMessages(HelicsFederate fed)
Definition: MessageFederateExport.cpp:527
void helicsEndpointAddSourceFilter(HelicsEndpoint endpoint, const char *filterName, HelicsError *err)
Definition: MessageFederateExport.cpp:754
int getOptionIndex(std::string val)
Definition: FederateInfo.cpp:408
HelicsTime helicsMessageGetTime(HelicsMessage message)
Definition: MessageFederateExport.cpp:868
virtual void registerInterfaces(const std::string &configString) override
Definition: MessageFederate.cpp:130
void helicsEndpointSendMessage(HelicsEndpoint endpoint, HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:300
void helicsEndpointSetInfo(HelicsEndpoint endpoint, const char *info, HelicsError *err)
Definition: MessageFederateExport.cpp:625
int getOptionValue(std::string val)
Definition: FederateInfo.cpp:427
virtual void updateTime(Time newTime, Time oldTime) override
Definition: MessageFederate.cpp:90
const char * helicsEndpointGetTag(HelicsEndpoint endpoint, const char *tagname)
Definition: MessageFederateExport.cpp:641
Definition: core-exceptions.hpp:48
virtual ~MessageFederate()
HelicsMessage helicsEndpointGetMessage(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:472
void addSourceFilter(std::string_view filterName)
Definition: Endpoints.cpp:163
const char * helicsMessageGetDestination(HelicsMessage message)
Definition: MessageFederateExport.cpp:841
void helicsMessageSetOriginalDestination(HelicsMessage message, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:986
bool hasMessage() const
Definition: MessageFederate.cpp:241
void setDefaultDestination(std::string_view target)
Definition: Endpoints.cpp:120
HelicsBool helicsFederateHasMessage(HelicsFederate fed)
Definition: MessageFederateExport.cpp:355
Definition: application_api/CoreApp.hpp:25
int helicsEndpointGetOption(HelicsEndpoint endpoint, int option)
Definition: MessageFederateExport.cpp:674
Endpoint & registerGlobalTargetedEndpoint(std::string_view eptName, std::string_view type=std::string_view())
Definition: MessageFederate.cpp:124
void helicsMessageFree(HelicsMessage message)
Definition: MessageFederateExport.cpp:1148
void helicsMessageAppendData(HelicsMessage message, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:1086
Definition: FederateInfo.hpp:24
void helicsEndpointSendBytesAt(HelicsEndpoint endpoint, const void *data, int inputDataLength, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:257
HelicsBool helicsMessageIsValid(HelicsMessage message)
Definition: MessageFederateExport.cpp:952
HelicsMessage helicsFederateGetMessage(HelicsFederate fed)
Definition: MessageFederateExport.cpp:488
Federate & operator=(Federate &&fed) noexcept
Definition: Federate.cpp:192
void setMessageNotificationCallback(const std::function< void(Endpoint &, Time)> &callback)
Endpoint & registerEndpoint(std::string_view eptName=std::string_view(), std::string_view type=std::string_view())
Definition: MessageFederate.cpp:109
HelicsEndpoint helicsFederateGetEndpoint(HelicsFederate fed, const char *name, HelicsError *err)
Definition: MessageFederateExport.cpp:132
void helicsEndpointAddDestinationFilter(HelicsEndpoint endpoint, const char *filterName, HelicsError *err)
Definition: MessageFederateExport.cpp:770
auto getID() const noexcept
Definition: application_api/Federate.hpp:701
HelicsEndpoint helicsFederateRegisterGlobalTargetedEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:109
void helicsMessageSetOriginalSource(HelicsMessage message, const char *src, HelicsError *err)
Definition: MessageFederateExport.cpp:978
void * HelicsEndpoint
Definition: api-data.h:37
void helicsMessageResize(HelicsMessage message, int newSize, HelicsError *err)
Definition: MessageFederateExport.cpp:1003
IterationResult
Definition: CoreTypes.hpp:83
void helicsMessageClear(HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:1095
HelicsMessage helicsEndpointCreateMessage(HelicsEndpoint endpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:515
const char * helicsEndpointGetInfo(HelicsEndpoint end)
Definition: MessageFederateExport.cpp:608
virtual void initializeToExecuteStateTransition(IterationResult result) override
Definition: MessageFederate.cpp:99
virtual std::string localQuery(std::string_view queryStr) const override
Definition: MessageFederate.cpp:104
Endpoint & getEndpoint(std::string_view name) const
Definition: MessageFederate.cpp:289
void helicsEndpointSendBytesToAt(HelicsEndpoint endpoint, const void *data, int inputDataLength, const char *dst, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:275
HelicsEndpoint helicsFederateRegisterGlobalEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:89
const char * helicsMessageGetString(HelicsMessage message)
Definition: MessageFederateExport.cpp:899
void helicsEndpointSendBytesTo(HelicsEndpoint endpoint, const void *data, int inputDataLength, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:239
void helicsMessageReserve(HelicsMessage message, int reserveSize, HelicsError *err)
Definition: MessageFederateExport.cpp:1017
void setTag(std::string_view tag, std::string_view value)
Definition: Federate.cpp:1625
void * HelicsMessage
Definition: api-data.h:94
void helicsEndpointSubscribe(HelicsEndpoint endpoint, const char *key, HelicsError *err)
Definition: MessageFederateExport.cpp:338
HelicsEndpoint helicsFederateRegisterTargetedEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:68
uint64_t pendingMessageCount() const
Definition: MessageFederate.cpp:265
void helicsEndpointRemoveTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:738
void addDestinationFilter(std::string_view filterName)
Definition: Endpoints.cpp:168
Definition: api-data.h:169
int helicsMessageGetMessageID(HelicsMessage message)
Definition: MessageFederateExport.cpp:877
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
void helicsMessageSetFlagOption(HelicsMessage message, int flag, HelicsBool flagValue, HelicsError *err)
Definition: MessageFederateExport.cpp:1049
void helicsMessageSetSource(HelicsMessage message, const char *src, HelicsError *err)
Definition: MessageFederateExport.cpp:961
int helicsFederatePendingMessageCount(HelicsFederate fed)
Definition: MessageFederateExport.cpp:373
void helicsEndpointSetDefaultDestination(HelicsEndpoint endpoint, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:194
void helicsMessageSetDestination(HelicsMessage message, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:970
const char * helicsEndpointGetType(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:570
const char * helicsEndpointGetName(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:588
Endpoint & registerTargetedEndpoint(std::string_view eptName=std::string_view(), std::string_view type=std::string_view())
Definition: MessageFederate.cpp:114
HelicsBool helicsEndpointHasMessage(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:364
void setInfo(std::string_view info)
Definition: Federate.cpp:1615
int helicsFederateGetEndpointCount(HelicsFederate fed)
Definition: MessageFederateExport.cpp:598
Definition: application_api/Federate.hpp:48
void helicsMessageSetString(HelicsMessage message, const char *data, HelicsError *err)
Definition: MessageFederateExport.cpp:1067
void helicsMessageGetBytes(HelicsMessage message, void *data, int maxMessageLength, int *actualSize, HelicsError *err)
Definition: MessageFederateExport.cpp:919
int getEndpointCount() const
Definition: MessageFederate.cpp:316
virtual void setOption(int32_t option, int32_t value=1)
Definition: Federate.cpp:1630
MessageFederate()
Definition: MessageFederate.cpp:59
std::shared_ptr< Core > coreObject
reference to the core simulation API
Definition: application_api/Federate.hpp:90
virtual void startupToInitializeStateTransition() override
Definition: MessageFederate.cpp:95
const char * helicsEndpointGetDefaultDestination(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:211
void helicsMessageSetData(HelicsMessage message, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:1077
int HelicsBool
Definition: api-data.h:112
Endpoint & registerGlobalEndpoint(std::string_view eptName, std::string_view type=std::string_view())
Definition: MessageFederate.cpp:119
virtual void disconnect()
Definition: Federate.cpp:653