 |
helics
3.0.1
|
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:841
void helicsMessageCopy(HelicsMessage src_message, HelicsMessage dst_message, HelicsError *err)
Definition: MessageFederateExport.cpp:1113
Common functions for the HELICS C api.
Endpoint & registerTargetedEndpoint(const std::string &eptName=std::string(), const std::string &type=std::string())
Definition: MessageFederate.cpp:117
void helicsEndpointSetTag(HelicsEndpoint endpoint, const char *tagname, const char *tagvalue, HelicsError *err)
Definition: MessageFederateExport.cpp:691
double HelicsTime
Definition: api-data.h:90
virtual void disconnect() override
Definition: MessageFederate.cpp:84
void helicsEndpointAddDestinationTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:755
void helicsEndpointSendBytes(HelicsEndpoint endpoint, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:248
HelicsEndpoint helicsFederateRegisterEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:48
const char * helicsMessageGetOriginalDestination(HelicsMessage message)
Definition: MessageFederateExport.cpp:868
void setInfo(const std::string &info)
Definition: Federate.cpp:1400
void helicsMessageClearFlags(HelicsMessage message)
Definition: MessageFederateExport.cpp:1049
Endpoint & registerEndpoint(const std::string &eptName=std::string(), const std::string &type=std::string())
Definition: MessageFederate.cpp:109
const std::string & getName() const
Definition: application_api/Federate.hpp:570
std::unique_ptr< Message > getMessage()
Definition: MessageFederate.cpp:281
FederateInfo loadFederateInfo(const std::string &configString)
Definition: FederateInfo.cpp:675
void subscribe(const std::string &key)
Definition: Endpoints.cpp:142
void helicsMessageSetMessageID(HelicsMessage message, int32_t messageID, HelicsError *err)
Definition: MessageFederateExport.cpp:1040
int helicsEndpointPendingMessageCount(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:416
void registerMessageInterfaces(const std::string &configString)
Definition: MessageFederate.cpp:144
void registerFilterInterfaces(const std::string &configString)
Definition: Federate.cpp:818
void * helicsMessageGetBytesPointer(HelicsMessage message)
Definition: MessageFederateExport.cpp:952
HelicsMessage helicsFederateCreateMessage(HelicsFederate fed, HelicsError *err)
Definition: MessageFederateExport.cpp:539
const char * helicsMessageGetOriginalSource(HelicsMessage message)
Definition: MessageFederateExport.cpp:859
void helicsEndpointSendMessageZeroCopy(HelicsEndpoint endpoint, HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:345
void helicsEndpointSetOption(HelicsEndpoint endpoint, int option, int value, HelicsError *err)
Definition: MessageFederateExport.cpp:723
Endpoint & registerGlobalEndpoint(const std::string &eptName, const std::string &type=std::string())
Definition: MessageFederate.cpp:126
void * HelicsFederate
Definition: api-data.h:60
int helicsMessageGetByteCount(HelicsMessage message)
Definition: MessageFederateExport.cpp:919
HelicsBool helicsEndpointIsValid(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:186
std::atomic< Modes > currentMode
the current state of the simulation
Definition: application_api/Federate.hpp:77
void subscribe(const Endpoint &ept, std::string_view key)
Definition: MessageFederate.cpp:244
TimeRepresentation< count_time< 9 > > Time
Definition: helicsTime.hpp:27
HelicsEndpoint helicsFederateGetEndpointByIndex(HelicsFederate fed, int index, HelicsError *err)
Definition: MessageFederateExport.cpp:160
void helicsMessageSetTime(HelicsMessage message, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:1003
Definition: Endpoints.hpp:21
void addDestinationFilter(const std::string &filterName)
Definition: Endpoints.cpp:181
HelicsMessage helicsMessageClone(HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:1133
void helicsEndpointAddSourceTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:739
HelicsBool helicsMessageGetFlagOption(HelicsMessage message, int flag)
Definition: MessageFederateExport.cpp:895
Definition: application_api/MessageFederate.hpp:22
Endpoint & getEndpoint(const std::string &name) const
Definition: MessageFederate.cpp:297
char nameSegmentSeparator
the separator between automatically prependend names
Definition: application_api/Federate.hpp:78
void helicsFederateClearMessages(HelicsFederate fed)
Definition: MessageFederateExport.cpp:560
void helicsEndpointAddSourceFilter(HelicsEndpoint endpoint, const char *filterName, HelicsError *err)
Definition: MessageFederateExport.cpp:787
int getOptionIndex(std::string val)
Definition: FederateInfo.cpp:385
HelicsTime helicsMessageGetTime(HelicsMessage message)
Definition: MessageFederateExport.cpp:877
virtual void registerInterfaces(const std::string &configString) override
Definition: MessageFederate.cpp:138
void helicsEndpointSendMessage(HelicsEndpoint endpoint, HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:327
void helicsEndpointSetInfo(HelicsEndpoint endpoint, const char *info, HelicsError *err)
Definition: MessageFederateExport.cpp:658
int getOptionValue(std::string val)
Definition: FederateInfo.cpp:404
virtual void updateTime(Time newTime, Time oldTime) override
Definition: MessageFederate.cpp:90
const char * helicsEndpointGetTag(HelicsEndpoint endpoint, const char *tagname)
Definition: MessageFederateExport.cpp:674
Definition: core-exceptions.hpp:47
virtual ~MessageFederate()
HelicsMessage helicsEndpointGetMessage(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:505
const char * helicsMessageGetDestination(HelicsMessage message)
Definition: MessageFederateExport.cpp:850
void helicsMessageSetOriginalDestination(HelicsMessage message, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:995
bool hasMessage() const
Definition: MessageFederate.cpp:249
void setDefaultDestination(std::string_view target)
Definition: Endpoints.cpp:128
HelicsBool helicsFederateHasMessage(HelicsFederate fed)
Definition: MessageFederateExport.cpp:389
Definition: application_api/CoreApp.hpp:25
int helicsEndpointGetOption(HelicsEndpoint endpoint, int option)
Definition: MessageFederateExport.cpp:707
Endpoint & registerGlobalTargetedEndpoint(const std::string &eptName, const std::string &type=std::string())
Definition: MessageFederate.cpp:132
void helicsMessageFree(HelicsMessage message)
Definition: MessageFederateExport.cpp:1157
void helicsMessageAppendData(HelicsMessage message, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:1095
Definition: FederateInfo.hpp:20
void helicsEndpointSendBytesAt(HelicsEndpoint endpoint, const void *data, int inputDataLength, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:284
HelicsBool helicsMessageIsValid(HelicsMessage message)
Definition: MessageFederateExport.cpp:961
HelicsMessage helicsFederateGetMessage(HelicsFederate fed)
Definition: MessageFederateExport.cpp:521
Federate & operator=(Federate &&fed) noexcept
Definition: Federate.cpp:190
void setMessageNotificationCallback(const std::function< void(Endpoint &, Time)> &callback)
HelicsEndpoint helicsFederateGetEndpoint(HelicsFederate fed, const char *name, HelicsError *err)
Definition: MessageFederateExport.cpp:133
void helicsEndpointAddDestinationFilter(HelicsEndpoint endpoint, const char *filterName, HelicsError *err)
Definition: MessageFederateExport.cpp:803
auto getID() const noexcept
Definition: application_api/Federate.hpp:563
HelicsEndpoint helicsFederateRegisterGlobalTargetedEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:110
void helicsMessageSetOriginalSource(HelicsMessage message, const char *src, HelicsError *err)
Definition: MessageFederateExport.cpp:987
void helicsMessageSetString(HelicsMessage message, const char *str, HelicsError *err)
Definition: MessageFederateExport.cpp:1076
void * HelicsEndpoint
Definition: api-data.h:37
void helicsMessageResize(HelicsMessage message, int newSize, HelicsError *err)
Definition: MessageFederateExport.cpp:1012
IterationResult
Definition: CoreTypes.hpp:80
void helicsMessageClear(HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:1104
HelicsMessage helicsEndpointCreateMessage(HelicsEndpoint endpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:548
const char * helicsEndpointGetInfo(HelicsEndpoint end)
Definition: MessageFederateExport.cpp:641
virtual void initializeToExecuteStateTransition(IterationResult result) override
Definition: MessageFederate.cpp:99
void helicsEndpointSendBytesToAt(HelicsEndpoint endpoint, const void *data, int inputDataLength, const char *dst, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:302
HelicsEndpoint helicsFederateRegisterGlobalEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:90
const char * helicsMessageGetString(HelicsMessage message)
Definition: MessageFederateExport.cpp:908
void helicsEndpointSendBytesTo(HelicsEndpoint endpoint, const void *data, int inputDataLength, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:266
void helicsMessageReserve(HelicsMessage message, int reserveSize, HelicsError *err)
Definition: MessageFederateExport.cpp:1026
void * HelicsMessage
Definition: api-data.h:84
void helicsEndpointSubscribe(HelicsEndpoint endpoint, const char *key, HelicsError *err)
Definition: MessageFederateExport.cpp:372
HelicsEndpoint helicsFederateRegisterTargetedEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:69
uint64_t pendingMessageCount() const
Definition: MessageFederate.cpp:273
void helicsEndpointRemoveTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:771
Definition: api-data.h:160
int helicsMessageGetMessageID(HelicsMessage message)
Definition: MessageFederateExport.cpp:886
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:1058
void helicsMessageSetSource(HelicsMessage message, const char *src, HelicsError *err)
Definition: MessageFederateExport.cpp:970
int helicsFederatePendingMessageCount(HelicsFederate fed)
Definition: MessageFederateExport.cpp:407
void logWarningMessage(const std::string &message) const
Definition: application_api/Federate.hpp:592
void helicsEndpointSetDefaultDestination(HelicsEndpoint endpoint, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:195
void helicsMessageSetDestination(HelicsMessage message, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:979
const char * helicsEndpointGetType(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:603
const char * helicsEndpointGetName(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:621
void addSourceFilter(const std::string &filterName)
Definition: Endpoints.cpp:174
HelicsBool helicsEndpointHasMessage(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:398
int helicsFederateGetEndpointCount(HelicsFederate fed)
Definition: MessageFederateExport.cpp:631
Definition: application_api/Federate.hpp:47
void helicsMessageGetBytes(HelicsMessage message, void *data, int maxMessageLength, int *actualSize, HelicsError *err)
Definition: MessageFederateExport.cpp:928
int getEndpointCount() const
Definition: MessageFederate.cpp:324
void setTag(const std::string &tag, const std::string &value)
Definition: Federate.cpp:1415
virtual void setOption(int32_t option, int32_t value=1)
Definition: Federate.cpp:1425
MessageFederate()
Definition: MessageFederate.cpp:59
std::shared_ptr< Core > coreObject
reference to the core simulation API
Definition: application_api/Federate.hpp:89
virtual void startupToInitializeStateTransition() override
Definition: MessageFederate.cpp:95
const char * helicsEndpointGetDefaultDestination(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:212
void helicsMessageSetData(HelicsMessage message, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:1086
virtual std::string localQuery(const std::string &queryStr) const override
Definition: MessageFederate.cpp:104
int HelicsBool
Definition: api-data.h:102
virtual void disconnect()
Definition: Federate.cpp:599