helics  3.3.0
MessageFederate.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2017-2022,
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 
13 #ifndef HELICS_APISHARED_MESSAGE_FEDERATE_FUNCTIONS_H_
14 #define HELICS_APISHARED_MESSAGE_FEDERATE_FUNCTIONS_H_
15 
16 #include "helicsCore.h"
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
22 /* MessageFederate Calls*/
23 
40 HELICS_EXPORT HelicsEndpoint helicsFederateRegisterEndpoint(HelicsFederate fed, const char* name, const char* type, HelicsError* err);
41 
57 HELICS_EXPORT HelicsEndpoint helicsFederateRegisterGlobalEndpoint(HelicsFederate fed, const char* name, const char* type, HelicsError* err);
58 
77  const char* name,
78  const char* type,
79  HelicsError* err);
80 
98  const char* name,
99  const char* type,
100  HelicsError* err);
101 
115 HELICS_EXPORT HelicsEndpoint helicsFederateGetEndpoint(HelicsFederate fed, const char* name, HelicsError* err);
116 
131 
139 HELICS_EXPORT HelicsBool helicsEndpointIsValid(HelicsEndpoint endpoint);
140 
149 HELICS_EXPORT void helicsEndpointSetDefaultDestination(HelicsEndpoint endpoint, const char* dst, HelicsError* err);
150 
158 HELICS_EXPORT const char* helicsEndpointGetDefaultDestination(HelicsEndpoint endpoint);
159 
169 HELICS_EXPORT void helicsEndpointSendBytes(HelicsEndpoint endpoint, const void* data, int inputDataLength, HelicsError* err);
170 
182 HELICS_EXPORT void
183  helicsEndpointSendBytesTo(HelicsEndpoint endpoint, const void* data, int inputDataLength, const char* dst, HelicsError* err);
184 
200 HELICS_EXPORT void helicsEndpointSendBytesToAt(HelicsEndpoint endpoint,
201  const void* data,
202  int inputDataLength,
203  const char* dst,
204  HelicsTime time,
205  HelicsError* err);
206 
221 HELICS_EXPORT void
222  helicsEndpointSendBytesAt(HelicsEndpoint endpoint, const void* data, int inputDataLength, HelicsTime time, HelicsError* err);
223 
232 HELICS_EXPORT void helicsEndpointSendMessage(HelicsEndpoint endpoint, HelicsMessage message, HelicsError* err);
233 
243 HELICS_EXPORT void helicsEndpointSendMessageZeroCopy(HelicsEndpoint endpoint, HelicsMessage message, HelicsError* err);
244 
253 HELICS_EXPORT void helicsEndpointSubscribe(HelicsEndpoint endpoint, const char* key, HelicsError* err);
254 
263 
271 HELICS_EXPORT HelicsBool helicsEndpointHasMessage(HelicsEndpoint endpoint);
272 
279 
285 HELICS_EXPORT int helicsEndpointPendingMessageCount(HelicsEndpoint endpoint);
286 
295 
309 
317 HELICS_EXPORT void helicsEndpointClearMessages(HelicsEndpoint endpoint);
318 
329 
343 
351 HELICS_EXPORT void helicsFederateClearMessages(HelicsFederate fed);
352 
360 HELICS_EXPORT const char* helicsEndpointGetType(HelicsEndpoint endpoint);
361 
369 HELICS_EXPORT const char* helicsEndpointGetName(HelicsEndpoint endpoint);
370 
378 HELICS_EXPORT int helicsFederateGetEndpointCount(HelicsFederate fed);
379 
387 HELICS_EXPORT const char* helicsEndpointGetInfo(HelicsEndpoint end);
388 
398 HELICS_EXPORT void helicsEndpointSetInfo(HelicsEndpoint endpoint, const char* info, HelicsError* err);
399 
407 HELICS_EXPORT const char* helicsEndpointGetTag(HelicsEndpoint endpoint, const char* tagname);
408 
419 HELICS_EXPORT void helicsEndpointSetTag(HelicsEndpoint endpoint, const char* tagname, const char* tagvalue, HelicsError* err);
420 
431 HELICS_EXPORT void helicsEndpointSetOption(HelicsEndpoint endpoint, int option, int value, HelicsError* err);
432 
440 HELICS_EXPORT int helicsEndpointGetOption(HelicsEndpoint endpoint, int option);
441 
451 HELICS_EXPORT void helicsEndpointAddSourceTarget(HelicsEndpoint endpoint, const char* targetEndpoint, HelicsError* err);
452 
462 HELICS_EXPORT void helicsEndpointAddDestinationTarget(HelicsEndpoint endpoint, const char* targetEndpoint, HelicsError* err);
463 
473 HELICS_EXPORT void helicsEndpointRemoveTarget(HelicsEndpoint endpoint, const char* targetEndpoint, HelicsError* err);
474 
484 HELICS_EXPORT void helicsEndpointAddSourceFilter(HelicsEndpoint endpoint, const char* filterName, HelicsError* err);
485 
494 HELICS_EXPORT void helicsEndpointAddDestinationFilter(HelicsEndpoint endpoint, const char* filterName, HelicsError* err);
495 
509 HELICS_EXPORT const char* helicsMessageGetSource(HelicsMessage message);
510 
518 HELICS_EXPORT const char* helicsMessageGetDestination(HelicsMessage message);
519 
527 HELICS_EXPORT const char* helicsMessageGetOriginalSource(HelicsMessage message);
528 
536 HELICS_EXPORT const char* helicsMessageGetOriginalDestination(HelicsMessage message);
537 
545 HELICS_EXPORT HelicsTime helicsMessageGetTime(HelicsMessage message);
546 
554 HELICS_EXPORT const char* helicsMessageGetString(HelicsMessage message);
555 
563 HELICS_EXPORT int helicsMessageGetMessageID(HelicsMessage message);
564 
573 HELICS_EXPORT HelicsBool helicsMessageGetFlagOption(HelicsMessage message, int flag);
574 
582 HELICS_EXPORT int helicsMessageGetByteCount(HelicsMessage message);
583 
594 HELICS_EXPORT void helicsMessageGetBytes(HelicsMessage message, void* data, int maxMessageLength, int* actualSize, HelicsError* err);
595 
603 HELICS_EXPORT void* helicsMessageGetBytesPointer(HelicsMessage message);
604 
612 HELICS_EXPORT HelicsBool helicsMessageIsValid(HelicsMessage message);
613 
622 HELICS_EXPORT void helicsMessageSetSource(HelicsMessage message, const char* src, HelicsError* err);
623 
632 HELICS_EXPORT void helicsMessageSetDestination(HelicsMessage message, const char* dst, HelicsError* err);
633 
642 HELICS_EXPORT void helicsMessageSetOriginalSource(HelicsMessage message, const char* src, HelicsError* err);
643 
652 HELICS_EXPORT void helicsMessageSetOriginalDestination(HelicsMessage message, const char* dst, HelicsError* err);
653 
662 HELICS_EXPORT void helicsMessageSetTime(HelicsMessage message, HelicsTime time, HelicsError* err);
663 
675 HELICS_EXPORT void helicsMessageResize(HelicsMessage message, int newSize, HelicsError* err);
676 
687 HELICS_EXPORT void helicsMessageReserve(HelicsMessage message, int reserveSize, HelicsError* err);
688 
699 HELICS_EXPORT void helicsMessageSetMessageID(HelicsMessage message, int32_t messageID, HelicsError* err);
700 
706 HELICS_EXPORT void helicsMessageClearFlags(HelicsMessage message);
707 
717 HELICS_EXPORT void helicsMessageSetFlagOption(HelicsMessage message, int flag, HelicsBool flagValue, HelicsError* err);
718 
727 HELICS_EXPORT void helicsMessageSetString(HelicsMessage message, const char* data, HelicsError* err);
728 
738 HELICS_EXPORT void helicsMessageSetData(HelicsMessage message, const void* data, int inputDataLength, HelicsError* err);
739 
749 HELICS_EXPORT void helicsMessageAppendData(HelicsMessage message, const void* data, int inputDataLength, HelicsError* err);
750 
759 HELICS_EXPORT void helicsMessageCopy(HelicsMessage src_message, HelicsMessage dst_message, HelicsError* err);
760 
768 HELICS_EXPORT HelicsMessage helicsMessageClone(HelicsMessage message, HelicsError* err);
769 
777 HELICS_EXPORT void helicsMessageFree(HelicsMessage message);
778 
786 HELICS_EXPORT void helicsMessageClear(HelicsMessage message, HelicsError* err);
787 
789 #ifdef __cplusplus
790 } /* end of extern "C" { */
791 #endif
792 
793 #endif /*HELICS_APISHARED_MESSAGE_FEDERATE_FUNCTIONS_H_*/
helicsMessageGetSource
const char * helicsMessageGetSource(HelicsMessage message)
Definition: MessageFederateExport.cpp:832
helicsMessageCopy
void helicsMessageCopy(HelicsMessage src_message, HelicsMessage dst_message, HelicsError *err)
Definition: MessageFederateExport.cpp:1104
helicsCore.h
Common functions for the HELICS C api.
helicsEndpointSetTag
void helicsEndpointSetTag(HelicsEndpoint endpoint, const char *tagname, const char *tagvalue, HelicsError *err)
Definition: MessageFederateExport.cpp:658
HelicsTime
double HelicsTime
Definition: api-data.h:100
helicsEndpointClearMessages
void helicsEndpointClearMessages(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:536
helics::MessageFederate::disconnect
virtual void disconnect() override
Definition: MessageFederate.cpp:84
helicsEndpointAddDestinationTarget
void helicsEndpointAddDestinationTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:722
helicsEndpointSendBytes
void helicsEndpointSendBytes(HelicsEndpoint endpoint, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:221
helicsFederateRegisterEndpoint
HelicsEndpoint helicsFederateRegisterEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:47
helicsMessageGetOriginalDestination
const char * helicsMessageGetOriginalDestination(HelicsMessage message)
Definition: MessageFederateExport.cpp:859
helics::Endpoint::subscribe
void subscribe(std::string_view key)
Definition: Endpoints.cpp:133
helicsMessageClearFlags
void helicsMessageClearFlags(HelicsMessage message)
Definition: MessageFederateExport.cpp:1040
helics::MessageFederate::getMessage
std::unique_ptr< Message > getMessage()
Definition: MessageFederate.cpp:273
helics::loadFederateInfo
FederateInfo loadFederateInfo(const std::string &configString)
Definition: FederateInfo.cpp:711
helicsMessageSetMessageID
void helicsMessageSetMessageID(HelicsMessage message, int32_t messageID, HelicsError *err)
Definition: MessageFederateExport.cpp:1031
helicsEndpointPendingMessageCount
int helicsEndpointPendingMessageCount(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:382
helics::MessageFederate::registerMessageInterfaces
void registerMessageInterfaces(const std::string &configString)
Definition: MessageFederate.cpp:136
helics::Federate::registerFilterInterfaces
void registerFilterInterfaces(const std::string &configString)
Definition: Federate.cpp:951
helicsMessageGetBytesPointer
void * helicsMessageGetBytesPointer(HelicsMessage message)
Definition: MessageFederateExport.cpp:943
helicsFederateCreateMessage
HelicsMessage helicsFederateCreateMessage(HelicsFederate fed, HelicsError *err)
Definition: MessageFederateExport.cpp:506
helicsMessageGetOriginalSource
const char * helicsMessageGetOriginalSource(HelicsMessage message)
Definition: MessageFederateExport.cpp:850
helicsEndpointSendMessageZeroCopy
void helicsEndpointSendMessageZeroCopy(HelicsEndpoint endpoint, HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:318
helicsEndpointSetOption
void helicsEndpointSetOption(HelicsEndpoint endpoint, int option, int value, HelicsError *err)
Definition: MessageFederateExport.cpp:690
HelicsFederate
void * HelicsFederate
Definition: api-data.h:65
helics::Federate::localNameGenerator
std::string localNameGenerator(std::string_view addition) const
Definition: Federate.cpp:1441
helicsMessageGetByteCount
int helicsMessageGetByteCount(HelicsMessage message)
Definition: MessageFederateExport.cpp:910
helicsEndpointIsValid
HelicsBool helicsEndpointIsValid(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:185
helics::Federate::currentMode
std::atomic< Modes > currentMode
the current state of the simulation
Definition: application_api/Federate.hpp:78
helics::MessageFederate::subscribe
void subscribe(const Endpoint &ept, std::string_view key)
Definition: MessageFederate.cpp:236
helics::Time
TimeRepresentation< count_time< 9 > > Time
Definition: helicsTime.hpp:27
helicsFederateGetEndpointByIndex
HelicsEndpoint helicsFederateGetEndpointByIndex(HelicsFederate fed, int index, HelicsError *err)
Definition: MessageFederateExport.cpp:159
helicsMessageSetTime
void helicsMessageSetTime(HelicsMessage message, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:994
helics::Endpoint
Definition: Endpoints.hpp:21
helics::Federate::logWarningMessage
void logWarningMessage(std::string_view message) const
Definition: application_api/Federate.hpp:728
helicsMessageClone
HelicsMessage helicsMessageClone(HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:1124
helicsEndpointAddSourceTarget
void helicsEndpointAddSourceTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:706
helicsMessageGetFlagOption
HelicsBool helicsMessageGetFlagOption(HelicsMessage message, int flag)
Definition: MessageFederateExport.cpp:886
helics::MessageFederate
Definition: application_api/MessageFederate.hpp:22
helicsFederateClearMessages
void helicsFederateClearMessages(HelicsFederate fed)
Definition: MessageFederateExport.cpp:527
helicsEndpointAddSourceFilter
void helicsEndpointAddSourceFilter(HelicsEndpoint endpoint, const char *filterName, HelicsError *err)
Definition: MessageFederateExport.cpp:754
helics::getOptionIndex
int getOptionIndex(std::string val)
Definition: FederateInfo.cpp:408
helicsMessageGetTime
HelicsTime helicsMessageGetTime(HelicsMessage message)
Definition: MessageFederateExport.cpp:868
helics::MessageFederate::registerInterfaces
virtual void registerInterfaces(const std::string &configString) override
Definition: MessageFederate.cpp:130
helicsEndpointSendMessage
void helicsEndpointSendMessage(HelicsEndpoint endpoint, HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:300
helicsEndpointSetInfo
void helicsEndpointSetInfo(HelicsEndpoint endpoint, const char *info, HelicsError *err)
Definition: MessageFederateExport.cpp:625
helics::getOptionValue
int getOptionValue(std::string val)
Definition: FederateInfo.cpp:427
helics::MessageFederate::updateTime
virtual void updateTime(Time newTime, Time oldTime) override
Definition: MessageFederate.cpp:90
helicsEndpointGetTag
const char * helicsEndpointGetTag(HelicsEndpoint endpoint, const char *tagname)
Definition: MessageFederateExport.cpp:641
helics::InvalidParameter
Definition: core-exceptions.hpp:48
helics::MessageFederate::~MessageFederate
virtual ~MessageFederate()
helicsEndpointGetMessage
HelicsMessage helicsEndpointGetMessage(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:472
helics::Endpoint::addSourceFilter
void addSourceFilter(std::string_view filterName)
Definition: Endpoints.cpp:163
helicsMessageGetDestination
const char * helicsMessageGetDestination(HelicsMessage message)
Definition: MessageFederateExport.cpp:841
helicsMessageSetOriginalDestination
void helicsMessageSetOriginalDestination(HelicsMessage message, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:986
helics::MessageFederate::hasMessage
bool hasMessage() const
Definition: MessageFederate.cpp:241
helics::Endpoint::setDefaultDestination
void setDefaultDestination(std::string_view target)
Definition: Endpoints.cpp:120
helicsFederateHasMessage
HelicsBool helicsFederateHasMessage(HelicsFederate fed)
Definition: MessageFederateExport.cpp:355
helics::CoreApp
Definition: application_api/CoreApp.hpp:25
helicsEndpointGetOption
int helicsEndpointGetOption(HelicsEndpoint endpoint, int option)
Definition: MessageFederateExport.cpp:674
helics::MessageFederate::registerGlobalTargetedEndpoint
Endpoint & registerGlobalTargetedEndpoint(std::string_view eptName, std::string_view type=std::string_view())
Definition: MessageFederate.cpp:124
helicsMessageFree
void helicsMessageFree(HelicsMessage message)
Definition: MessageFederateExport.cpp:1148
helicsMessageAppendData
void helicsMessageAppendData(HelicsMessage message, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:1086
helics::FederateInfo
Definition: FederateInfo.hpp:24
helicsEndpointSendBytesAt
void helicsEndpointSendBytesAt(HelicsEndpoint endpoint, const void *data, int inputDataLength, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:257
helicsMessageIsValid
HelicsBool helicsMessageIsValid(HelicsMessage message)
Definition: MessageFederateExport.cpp:952
helicsFederateGetMessage
HelicsMessage helicsFederateGetMessage(HelicsFederate fed)
Definition: MessageFederateExport.cpp:488
helics::Federate::operator=
Federate & operator=(Federate &&fed) noexcept
Definition: Federate.cpp:192
helics::MessageFederate::setMessageNotificationCallback
void setMessageNotificationCallback(const std::function< void(Endpoint &, Time)> &callback)
helics::MessageFederate::registerEndpoint
Endpoint & registerEndpoint(std::string_view eptName=std::string_view(), std::string_view type=std::string_view())
Definition: MessageFederate.cpp:109
helicsFederateGetEndpoint
HelicsEndpoint helicsFederateGetEndpoint(HelicsFederate fed, const char *name, HelicsError *err)
Definition: MessageFederateExport.cpp:132
helicsEndpointAddDestinationFilter
void helicsEndpointAddDestinationFilter(HelicsEndpoint endpoint, const char *filterName, HelicsError *err)
Definition: MessageFederateExport.cpp:770
helics::Federate::getID
auto getID() const noexcept
Definition: application_api/Federate.hpp:701
helicsFederateRegisterGlobalTargetedEndpoint
HelicsEndpoint helicsFederateRegisterGlobalTargetedEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:109
helics::Federate::Modes::INITIALIZING
@ INITIALIZING
helicsMessageSetOriginalSource
void helicsMessageSetOriginalSource(HelicsMessage message, const char *src, HelicsError *err)
Definition: MessageFederateExport.cpp:978
HelicsEndpoint
void * HelicsEndpoint
Definition: api-data.h:37
helicsMessageResize
void helicsMessageResize(HelicsMessage message, int newSize, HelicsError *err)
Definition: MessageFederateExport.cpp:1003
helics::IterationResult
IterationResult
Definition: CoreTypes.hpp:83
helicsMessageClear
void helicsMessageClear(HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:1095
helicsEndpointCreateMessage
HelicsMessage helicsEndpointCreateMessage(HelicsEndpoint endpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:515
helicsEndpointGetInfo
const char * helicsEndpointGetInfo(HelicsEndpoint end)
Definition: MessageFederateExport.cpp:608
helics::MessageFederate::initializeToExecuteStateTransition
virtual void initializeToExecuteStateTransition(IterationResult result) override
Definition: MessageFederate.cpp:99
helics::MessageFederate::localQuery
virtual std::string localQuery(std::string_view queryStr) const override
Definition: MessageFederate.cpp:104
helics::MessageFederate::getEndpoint
Endpoint & getEndpoint(std::string_view name) const
Definition: MessageFederate.cpp:289
helicsEndpointSendBytesToAt
void helicsEndpointSendBytesToAt(HelicsEndpoint endpoint, const void *data, int inputDataLength, const char *dst, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:275
helicsFederateRegisterGlobalEndpoint
HelicsEndpoint helicsFederateRegisterGlobalEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:89
helicsMessageGetString
const char * helicsMessageGetString(HelicsMessage message)
Definition: MessageFederateExport.cpp:899
helicsEndpointSendBytesTo
void helicsEndpointSendBytesTo(HelicsEndpoint endpoint, const void *data, int inputDataLength, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:239
helicsMessageReserve
void helicsMessageReserve(HelicsMessage message, int reserveSize, HelicsError *err)
Definition: MessageFederateExport.cpp:1017
helics::Interface::setTag
void setTag(std::string_view tag, std::string_view value)
Definition: Federate.cpp:1625
HelicsMessage
void * HelicsMessage
Definition: api-data.h:94
helicsEndpointSubscribe
void helicsEndpointSubscribe(HelicsEndpoint endpoint, const char *key, HelicsError *err)
Definition: MessageFederateExport.cpp:338
helicsFederateRegisterTargetedEndpoint
HelicsEndpoint helicsFederateRegisterTargetedEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:68
helics::MessageFederate::pendingMessageCount
uint64_t pendingMessageCount() const
Definition: MessageFederate.cpp:265
helicsEndpointRemoveTarget
void helicsEndpointRemoveTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:738
helics::Endpoint::addDestinationFilter
void addDestinationFilter(std::string_view filterName)
Definition: Endpoints.cpp:168
HelicsError
Definition: api-data.h:169
helicsMessageGetMessageID
int helicsMessageGetMessageID(HelicsMessage message)
Definition: MessageFederateExport.cpp:877
helics
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
helicsMessageSetFlagOption
void helicsMessageSetFlagOption(HelicsMessage message, int flag, HelicsBool flagValue, HelicsError *err)
Definition: MessageFederateExport.cpp:1049
helicsMessageSetSource
void helicsMessageSetSource(HelicsMessage message, const char *src, HelicsError *err)
Definition: MessageFederateExport.cpp:961
helicsFederatePendingMessageCount
int helicsFederatePendingMessageCount(HelicsFederate fed)
Definition: MessageFederateExport.cpp:373
helicsEndpointSetDefaultDestination
void helicsEndpointSetDefaultDestination(HelicsEndpoint endpoint, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:194
helicsMessageSetDestination
void helicsMessageSetDestination(HelicsMessage message, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:970
helicsEndpointGetType
const char * helicsEndpointGetType(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:570
helicsEndpointGetName
const char * helicsEndpointGetName(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:588
helics::MessageFederate::registerTargetedEndpoint
Endpoint & registerTargetedEndpoint(std::string_view eptName=std::string_view(), std::string_view type=std::string_view())
Definition: MessageFederate.cpp:114
helicsEndpointHasMessage
HelicsBool helicsEndpointHasMessage(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:364
helics::Interface::setInfo
void setInfo(std::string_view info)
Definition: Federate.cpp:1615
helicsFederateGetEndpointCount
int helicsFederateGetEndpointCount(HelicsFederate fed)
Definition: MessageFederateExport.cpp:598
helics::Federate
Definition: application_api/Federate.hpp:48
helicsMessageSetString
void helicsMessageSetString(HelicsMessage message, const char *data, HelicsError *err)
Definition: MessageFederateExport.cpp:1067
helicsMessageGetBytes
void helicsMessageGetBytes(HelicsMessage message, void *data, int maxMessageLength, int *actualSize, HelicsError *err)
Definition: MessageFederateExport.cpp:919
helics::MessageFederate::getEndpointCount
int getEndpointCount() const
Definition: MessageFederate.cpp:316
helics::Interface::setOption
virtual void setOption(int32_t option, int32_t value=1)
Definition: Federate.cpp:1630
helics::MessageFederate::MessageFederate
MessageFederate()
Definition: MessageFederate.cpp:59
helics::Federate::coreObject
std::shared_ptr< Core > coreObject
reference to the core simulation API
Definition: application_api/Federate.hpp:90
helics::MessageFederate::startupToInitializeStateTransition
virtual void startupToInitializeStateTransition() override
Definition: MessageFederate.cpp:95
helicsEndpointGetDefaultDestination
const char * helicsEndpointGetDefaultDestination(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:211
helicsMessageSetData
void helicsMessageSetData(HelicsMessage message, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:1077
HelicsBool
int HelicsBool
Definition: api-data.h:112
helics::MessageFederate::registerGlobalEndpoint
Endpoint & registerGlobalEndpoint(std::string_view eptName, std::string_view type=std::string_view())
Definition: MessageFederate.cpp:119
helics::Federate::disconnect
virtual void disconnect()
Definition: Federate.cpp:653