 |
helics
2.8.1
|
Go to the documentation of this file.
13 #ifndef HELICS_APISHARED_MESSAGE_FEDERATE_FUNCTIONS_H_
14 #define HELICS_APISHARED_MESSAGE_FEDERATE_FUNCTIONS_H_
void registerKnownCommunicationPath(const Endpoint &localEndpoint, const std::string &remoteEndpoint)
Definition: MessageFederate.cpp:233
@ data
print timing+data transmissions
Definition: loggingHelper.hpp:30
std::atomic< modes > currentMode
the current state of the simulation
Definition: application_api/Federate.hpp:65
void helicsMessageCopy(helics_message_object src_message, helics_message_object dst_message, helics_error *err)
Definition: MessageFederateExport.cpp:1022
int helicsFederatePendingMessageCount(helics_federate fed)
Definition: MessageFederateExport.cpp:356
virtual void disconnect() override
Definition: MessageFederate.cpp:84
bool isMember(const toml::value &element, const std::string &key)
Definition: TomlProcessingFunctions.hpp:148
void helicsMessageSetMessageID(helics_message_object message, int32_t messageID, helics_error *err)
Definition: MessageFederateExport.cpp:950
helics_bool helicsFederateHasMessage(helics_federate fed)
Definition: MessageFederateExport.cpp:338
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:546
HELICS_DEPRECATED_EXPORT int helicsFederatePendingMessages(helics_federate fed)
Definition: MessageFederateExport.cpp:365
int helicsMessageGetMessageID(helics_message_object message)
Definition: MessageFederateExport.cpp:798
std::unique_ptr< Message > getMessage()
Definition: MessageFederate.cpp:271
void helicsEndpointSendMessageObject(helics_endpoint endpoint, helics_message_object message, helics_error *err)
Definition: MessageFederateExport.cpp:276
helics_endpoint helicsFederateGetEndpointByIndex(helics_federate fed, int index, helics_error *err)
Definition: MessageFederateExport.cpp:119
FederateInfo loadFederateInfo(const std::string &configString)
Definition: FederateInfo.cpp:639
void helicsMessageSetOriginalDestination(helics_message_object message, const char *dst, helics_error *err)
Definition: MessageFederateExport.cpp:905
int helicsEndpointPendingMessageCount(helics_endpoint endpoint)
Definition: MessageFederateExport.cpp:370
void sendMessage(const Endpoint &source, const std::string &dest, const char *data, size_t dataLength)
Definition: application_api/MessageFederate.hpp:190
void helicsEndpointSetDefaultDestination(helics_endpoint endpoint, const char *dst, helics_error *err)
Definition: MessageFederateExport.cpp:154
void registerMessageInterfaces(const std::string &configString)
Definition: MessageFederate.cpp:129
void helicsMessageSetTime(helics_message_object message, helics_time time, helics_error *err)
Definition: MessageFederateExport.cpp:913
void registerFilterInterfaces(const std::string &configString)
Definition: Federate.cpp:798
helics_endpoint helicsFederateRegisterEndpoint(helics_federate fed, const char *name, const char *type, helics_error *err)
Definition: MessageFederateExport.cpp:48
Endpoint & registerGlobalEndpoint(const std::string &eptName, const std::string &type=std::string())
Definition: MessageFederate.cpp:117
void helicsMessageClearFlags(helics_message_object message)
Definition: MessageFederateExport.cpp:959
HELICS_DEPRECATED_EXPORT helics_message helicsFederateGetMessage(helics_federate fed)
Definition: MessageFederateExport.cpp:506
iteration_result
Definition: core-types.hpp:81
void * helics_message_object
Definition: api-data.h:76
helics_message_object helicsMessageClone(helics_message_object message, helics_error *err)
Definition: MessageFederateExport.cpp:1042
TimeRepresentation< count_time< 9 > > Time
Definition: helics-time.hpp:27
toml::value loadToml(const std::string &tomlString)
Definition: TomlProcessingFunctions.cpp:22
double helics_time
Definition: api-data.h:81
const char * helicsMessageGetOriginalDestination(helics_message_object message)
Definition: MessageFederateExport.cpp:780
void setDefaultDestination(std::string target)
Definition: Endpoints.hpp:198
Common functions for the HELICS C api.
Definition: Endpoints.hpp:18
void addDestinationFilter(const std::string &filterName)
Definition: Endpoints.hpp:193
HELICS_DEPRECATED_EXPORT void helicsEndpointSendMessage(helics_endpoint endpoint, helics_message *message, helics_error *err)
Definition: MessageFederateExport.cpp:240
helics_bool helicsEndpointIsValid(helics_endpoint endpoint)
Definition: MessageFederateExport.cpp:145
uint64_t pendingMessages() const
Definition: MessageFederate.cpp:263
void helicsMessageClear(helics_message_object message, helics_error *err)
Definition: MessageFederateExport.cpp:1013
void helicsEndpointSendEventRaw(helics_endpoint endpoint, const char *dst, const void *data, int inputDataLength, helics_time time, helics_error *err)
Definition: MessageFederateExport.cpp:207
void helicsMessageSetFlagOption(helics_message_object message, int flag, helics_bool flagValue, helics_error *err)
Definition: MessageFederateExport.cpp:968
helics_endpoint helicsFederateRegisterGlobalEndpoint(helics_federate fed, const char *name, const char *type, helics_error *err)
Definition: MessageFederateExport.cpp:69
Definition: data_view.hpp:22
Definition: application_api/MessageFederate.hpp:20
Endpoint & getEndpoint(const std::string &name) const
Definition: MessageFederate.cpp:332
char nameSegmentSeparator
the separator between automatically prependend names
Definition: application_api/Federate.hpp:66
std::string getKey(const Json::Value &element)
Definition: JsonProcessingFunctions.cpp:90
helics_message_object helicsFederateCreateMessageObject(helics_federate fed, helics_error *err)
Definition: MessageFederateExport.cpp:565
Definition: api-data.h:147
int getOptionIndex(std::string val)
Definition: FederateInfo.cpp:356
virtual void registerInterfaces(const std::string &configString) override
Definition: MessageFederate.cpp:123
int getOptionValue(std::string val)
Definition: FederateInfo.cpp:375
Definition: core-exceptions.hpp:67
virtual void updateTime(Time newTime, Time oldTime) override
Definition: MessageFederate.cpp:90
helics_message_object helicsEndpointCreateMessageObject(helics_endpoint endpoint, helics_error *err)
Definition: MessageFederateExport.cpp:574
HELICS_DEPRECATED_EXPORT helics_message helicsEndpointGetMessage(helics_endpoint endpoint)
Definition: MessageFederateExport.cpp:482
void helicsMessageGetRawData(helics_message_object message, void *data, int maxMessageLength, int *actualSize, helics_error *err)
Definition: MessageFederateExport.cpp:838
Definition: core-exceptions.hpp:48
virtual ~MessageFederate()
const char * helicsMessageGetString(helics_message_object message)
Definition: MessageFederateExport.cpp:820
helics_bool helicsMessageIsValid(helics_message_object message)
Definition: MessageFederateExport.cpp:871
helics_bool helicsMessageCheckFlag(helics_message_object message, int flag)
Definition: MessageFederateExport.cpp:807
bool hasMessage() const
Definition: MessageFederate.cpp:239
const char * helicsEndpointGetType(helics_endpoint endpoint)
Definition: MessageFederateExport.cpp:629
Definition: application_api/CoreApp.hpp:25
void helicsMessageSetOriginalSource(helics_message_object message, const char *src, helics_error *err)
Definition: MessageFederateExport.cpp:897
const char * helicsMessageGetDestination(helics_message_object message)
Definition: MessageFederateExport.cpp:762
void helicsEndpointSendMessageRaw(helics_endpoint endpoint, const char *dst, const void *data, int inputDataLength, helics_error *err)
Definition: MessageFederateExport.cpp:181
void helicsMessageSetSource(helics_message_object message, const char *src, helics_error *err)
Definition: MessageFederateExport.cpp:880
Definition: FederateInfo.hpp:20
int helicsEndpointGetOption(helics_endpoint endpoint, int option)
Definition: MessageFederateExport.cpp:699
void helicsEndpointSubscribe(helics_endpoint endpoint, const char *key, helics_error *err)
Definition: MessageFederateExport.cpp:321
HELICS_DEPRECATED_EXPORT void helicsEndpointClearMessages(helics_endpoint endpoint)
Definition: MessageFederateExport.cpp:595
Federate & operator=(Federate &&fed) noexcept
Definition: Federate.cpp:183
void setMessageNotificationCallback(const std::function< void(Endpoint &, Time)> &callback)
void * helics_endpoint
Definition: api-data.h:36
void subscribe(const Endpoint &ept, const std::string &key)
Definition: MessageFederate.cpp:228
helics_time helicsMessageGetTime(helics_message_object message)
Definition: MessageFederateExport.cpp:789
Json::Value loadJson(const std::string &jsonString)
Definition: JsonProcessingFunctions.cpp:24
interface_handle getHandle() const
** get the number of filters applied to the endpoint*/
Definition: Endpoints.hpp:210
auto getID() const noexcept
Definition: application_api/Federate.hpp:539
@ fed
special logging command for message coming from a fed
Definition: loggingHelper.hpp:32
void helicsMessageResize(helics_message_object message, int newSize, helics_error *err)
Definition: MessageFederateExport.cpp:922
void helicsMessageSetDestination(helics_message_object message, const char *dst, helics_error *err)
Definition: MessageFederateExport.cpp:889
void helicsMessageSetString(helics_message_object message, const char *str, helics_error *err)
Definition: MessageFederateExport.cpp:986
HELICS_DEPRECATED_EXPORT int helicsEndpointPendingMessages(helics_endpoint endpoint)
Definition: MessageFederateExport.cpp:379
const char * helicsMessageGetSource(helics_message_object message)
Definition: MessageFederateExport.cpp:753
Definition: api-data.h:166
helics_endpoint helicsFederateGetEndpoint(helics_federate fed, const char *name, helics_error *err)
Definition: MessageFederateExport.cpp:92
void addSourceFilter(const Endpoint &ept, const std::string &filterName)
Definition: MessageFederate.cpp:364
void helicsMessageReserve(helics_message_object message, int reserveSize, helics_error *err)
Definition: MessageFederateExport.cpp:936
void helicsMessageFree(helics_message_object message)
Definition: MessageFederateExport.cpp:1066
const char * helicsEndpointGetName(helics_endpoint endpoint)
Definition: MessageFederateExport.cpp:647
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
void helicsFederateClearMessages(helics_federate fed)
Definition: MessageFederateExport.cpp:586
int helicsFederateGetEndpointCount(helics_federate fed)
Definition: MessageFederateExport.cpp:657
void addDestinationFilter(const Endpoint &ept, const std::string &filterName)
Definition: MessageFederate.cpp:369
void helicsMessageAppendData(helics_message_object message, const void *data, int inputDataLength, helics_error *err)
Definition: MessageFederateExport.cpp:1004
void * helicsMessageGetRawDataPointer(helics_message_object message)
Definition: MessageFederateExport.cpp:862
void helicsEndpointSetOption(helics_endpoint endpoint, int option, int value, helics_error *err)
Definition: MessageFederateExport.cpp:715
void addSourceFilter(const std::string &filterName)
Definition: Endpoints.hpp:191
const char * helicsEndpointGetInfo(helics_endpoint end)
Definition: MessageFederateExport.cpp:667
int helicsMessageGetRawDataSize(helics_message_object message)
Definition: MessageFederateExport.cpp:829
virtual void initializeToExecuteStateTransition(iteration_result result) override
Definition: MessageFederate.cpp:99
Definition: application_api/Federate.hpp:44
helics_message_object helicsFederateGetMessageObject(helics_federate fed)
Definition: MessageFederateExport.cpp:547
helics_bool helicsEndpointHasMessage(helics_endpoint endpoint)
Definition: MessageFederateExport.cpp:347
void helicsMessageSetData(helics_message_object message, const void *data, int inputDataLength, helics_error *err)
Definition: MessageFederateExport.cpp:995
helics_message_object helicsEndpointGetMessageObject(helics_endpoint endpoint)
Definition: MessageFederateExport.cpp:531
int getEndpointCount() const
Definition: MessageFederate.cpp:359
int helics_bool
Definition: api-data.h:92
MessageFederate()
Definition: MessageFederate.cpp:59
std::shared_ptr< Core > coreObject
reference to the core simulation API
Definition: application_api/Federate.hpp:75
virtual void startupToInitializeStateTransition() override
Definition: MessageFederate.cpp:95
void helicsEndpointSetInfo(helics_endpoint endpoint, const char *info, helics_error *err)
Definition: MessageFederateExport.cpp:683
const char * helicsMessageGetOriginalSource(helics_message_object message)
Definition: MessageFederateExport.cpp:771
virtual std::string localQuery(const std::string &queryStr) const override
Definition: MessageFederate.cpp:104
const char * helicsEndpointGetDefaultDestination(helics_endpoint endpoint)
Definition: MessageFederateExport.cpp:171
@ initializing
entered after the enterInitializingMode call has returned
Definition: core-data.hpp:146
void * helics_federate
Definition: api-data.h:56
@ executing
entered after the enterExectuationState call has returned
void helicsEndpointSendMessageObjectZeroCopy(helics_endpoint endpoint, helics_message_object message, helics_error *err)
Definition: MessageFederateExport.cpp:294
virtual void disconnect()
Definition: Federate.cpp:567