helics  3.0.1
MessageFederate.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 
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 
42 HELICS_EXPORT HelicsEndpoint helicsFederateRegisterEndpoint(HelicsFederate fed, const char* name, const char* type, HelicsError* err);
43 
62 HELICS_EXPORT HelicsEndpoint helicsFederateRegisterGlobalEndpoint(HelicsFederate fed, const char* name, const char* type, HelicsError* err);
63 
85  const char* name,
86  const char* type,
87  HelicsError* err);
88 
109  const char* name,
110  const char* type,
111  HelicsError* err);
112 
127 HELICS_EXPORT HelicsEndpoint helicsFederateGetEndpoint(HelicsFederate fed, const char* name, HelicsError* err);
128 
144 
152 HELICS_EXPORT HelicsBool helicsEndpointIsValid(HelicsEndpoint endpoint);
153 
163 HELICS_EXPORT void helicsEndpointSetDefaultDestination(HelicsEndpoint endpoint, const char* dst, HelicsError* err);
164 
172 HELICS_EXPORT const char* helicsEndpointGetDefaultDestination(HelicsEndpoint endpoint);
173 
184 HELICS_EXPORT void helicsEndpointSendBytes(HelicsEndpoint endpoint, const void* data, int inputDataLength, HelicsError* err);
185 
199 HELICS_EXPORT void
200  helicsEndpointSendBytesTo(HelicsEndpoint endpoint, const void* data, int inputDataLength, const char* dst, HelicsError* err);
201 
218 HELICS_EXPORT void helicsEndpointSendBytesToAt(HelicsEndpoint endpoint,
219  const void* data,
220  int inputDataLength,
221  const char* dst,
222  HelicsTime time,
223  HelicsError* err);
224 
240 HELICS_EXPORT void
241  helicsEndpointSendBytesAt(HelicsEndpoint endpoint, const void* data, int inputDataLength, HelicsTime time, HelicsError* err);
242 
252 HELICS_EXPORT void helicsEndpointSendMessage(HelicsEndpoint endpoint, HelicsMessage message, HelicsError* err);
253 
264 HELICS_EXPORT void helicsEndpointSendMessageZeroCopy(HelicsEndpoint endpoint, HelicsMessage message, HelicsError* err);
265 
275 HELICS_EXPORT void helicsEndpointSubscribe(HelicsEndpoint endpoint, const char* key, HelicsError* err);
276 
285 
293 HELICS_EXPORT HelicsBool helicsEndpointHasMessage(HelicsEndpoint endpoint);
294 
301 
307 HELICS_EXPORT int helicsEndpointPendingMessageCount(HelicsEndpoint endpoint);
308 
317 
331 
342 
356 
364 HELICS_EXPORT void helicsFederateClearMessages(HelicsFederate fed);
365 
373 HELICS_EXPORT const char* helicsEndpointGetType(HelicsEndpoint endpoint);
374 
382 HELICS_EXPORT const char* helicsEndpointGetName(HelicsEndpoint endpoint);
383 
391 HELICS_EXPORT int helicsFederateGetEndpointCount(HelicsFederate fed);
392 
400 HELICS_EXPORT const char* helicsEndpointGetInfo(HelicsEndpoint end);
401 
411 HELICS_EXPORT void helicsEndpointSetInfo(HelicsEndpoint endpoint, const char* info, HelicsError* err);
412 
420 HELICS_EXPORT const char* helicsEndpointGetTag(HelicsEndpoint endpoint, const char* tagname);
421 
432 HELICS_EXPORT void helicsEndpointSetTag(HelicsEndpoint endpoint, const char* tagname, const char* tagvalue, HelicsError* err);
433 
444 HELICS_EXPORT void helicsEndpointSetOption(HelicsEndpoint endpoint, int option, int value, HelicsError* err);
445 
453 HELICS_EXPORT int helicsEndpointGetOption(HelicsEndpoint endpoint, int option);
454 
464 HELICS_EXPORT void helicsEndpointAddSourceTarget(HelicsEndpoint endpoint, const char* targetEndpoint, HelicsError* err);
465 
475 HELICS_EXPORT void helicsEndpointAddDestinationTarget(HelicsEndpoint endpoint, const char* targetEndpoint, HelicsError* err);
476 
486 HELICS_EXPORT void helicsEndpointRemoveTarget(HelicsEndpoint endpoint, const char* targetEndpoint, HelicsError* err);
487 
497 HELICS_EXPORT void helicsEndpointAddSourceFilter(HelicsEndpoint endpoint, const char* filterName, HelicsError* err);
498 
507 HELICS_EXPORT void helicsEndpointAddDestinationFilter(HelicsEndpoint endpoint, const char* filterName, HelicsError* err);
508 
522 HELICS_EXPORT const char* helicsMessageGetSource(HelicsMessage message);
523 
531 HELICS_EXPORT const char* helicsMessageGetDestination(HelicsMessage message);
532 
540 HELICS_EXPORT const char* helicsMessageGetOriginalSource(HelicsMessage message);
541 
549 HELICS_EXPORT const char* helicsMessageGetOriginalDestination(HelicsMessage message);
550 
558 HELICS_EXPORT HelicsTime helicsMessageGetTime(HelicsMessage message);
559 
567 HELICS_EXPORT const char* helicsMessageGetString(HelicsMessage message);
568 
576 HELICS_EXPORT int helicsMessageGetMessageID(HelicsMessage message);
577 
586 HELICS_EXPORT HelicsBool helicsMessageGetFlagOption(HelicsMessage message, int flag);
587 
595 HELICS_EXPORT int helicsMessageGetByteCount(HelicsMessage message);
596 
607 HELICS_EXPORT void helicsMessageGetBytes(HelicsMessage message, void* data, int maxMessageLength, int* actualSize, HelicsError* err);
608 
616 HELICS_EXPORT void* helicsMessageGetBytesPointer(HelicsMessage message);
617 
625 HELICS_EXPORT HelicsBool helicsMessageIsValid(HelicsMessage message);
626 
635 HELICS_EXPORT void helicsMessageSetSource(HelicsMessage message, const char* src, HelicsError* err);
636 
645 HELICS_EXPORT void helicsMessageSetDestination(HelicsMessage message, const char* dst, HelicsError* err);
646 
655 HELICS_EXPORT void helicsMessageSetOriginalSource(HelicsMessage message, const char* src, HelicsError* err);
656 
665 HELICS_EXPORT void helicsMessageSetOriginalDestination(HelicsMessage message, const char* dst, HelicsError* err);
666 
675 HELICS_EXPORT void helicsMessageSetTime(HelicsMessage message, HelicsTime time, HelicsError* err);
676 
688 HELICS_EXPORT void helicsMessageResize(HelicsMessage message, int newSize, HelicsError* err);
689 
700 HELICS_EXPORT void helicsMessageReserve(HelicsMessage message, int reserveSize, HelicsError* err);
701 
712 HELICS_EXPORT void helicsMessageSetMessageID(HelicsMessage message, int32_t messageID, HelicsError* err);
713 
719 HELICS_EXPORT void helicsMessageClearFlags(HelicsMessage message);
720 
730 HELICS_EXPORT void helicsMessageSetFlagOption(HelicsMessage message, int flag, HelicsBool flagValue, HelicsError* err);
731 
740 HELICS_EXPORT void helicsMessageSetString(HelicsMessage message, const char* str, HelicsError* err);
741 
751 HELICS_EXPORT void helicsMessageSetData(HelicsMessage message, const void* data, int inputDataLength, HelicsError* err);
752 
762 HELICS_EXPORT void helicsMessageAppendData(HelicsMessage message, const void* data, int inputDataLength, HelicsError* err);
763 
772 HELICS_EXPORT void helicsMessageCopy(HelicsMessage src_message, HelicsMessage dst_message, HelicsError* err);
773 
781 HELICS_EXPORT HelicsMessage helicsMessageClone(HelicsMessage message, HelicsError* err);
782 
790 HELICS_EXPORT void helicsMessageFree(HelicsMessage message);
791 
799 HELICS_EXPORT void helicsMessageClear(HelicsMessage message, HelicsError* err);
800 
802 #ifdef __cplusplus
803 } /* end of extern "C" { */
804 #endif
805 
806 #endif /*HELICS_APISHARED_MESSAGE_FEDERATE_FUNCTIONS_H_*/
helicsMessageGetSource
const char * helicsMessageGetSource(HelicsMessage message)
Definition: MessageFederateExport.cpp:841
helicsMessageCopy
void helicsMessageCopy(HelicsMessage src_message, HelicsMessage dst_message, HelicsError *err)
Definition: MessageFederateExport.cpp:1113
helicsCore.h
Common functions for the HELICS C api.
helics::MessageFederate::registerTargetedEndpoint
Endpoint & registerTargetedEndpoint(const std::string &eptName=std::string(), const std::string &type=std::string())
Definition: MessageFederate.cpp:117
helicsEndpointSetTag
void helicsEndpointSetTag(HelicsEndpoint endpoint, const char *tagname, const char *tagvalue, HelicsError *err)
Definition: MessageFederateExport.cpp:691
HelicsTime
double HelicsTime
Definition: api-data.h:90
helics::MessageFederate::disconnect
virtual void disconnect() override
Definition: MessageFederate.cpp:84
helicsEndpointAddDestinationTarget
void helicsEndpointAddDestinationTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:755
helicsEndpointSendBytes
void helicsEndpointSendBytes(HelicsEndpoint endpoint, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:248
helicsFederateRegisterEndpoint
HelicsEndpoint helicsFederateRegisterEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:48
helicsMessageGetOriginalDestination
const char * helicsMessageGetOriginalDestination(HelicsMessage message)
Definition: MessageFederateExport.cpp:868
helics::Interface::setInfo
void setInfo(const std::string &info)
Definition: Federate.cpp:1400
helicsMessageClearFlags
void helicsMessageClearFlags(HelicsMessage message)
Definition: MessageFederateExport.cpp:1049
helics::MessageFederate::registerEndpoint
Endpoint & registerEndpoint(const std::string &eptName=std::string(), const std::string &type=std::string())
Definition: MessageFederate.cpp:109
helics::Federate::getName
const std::string & getName() const
Definition: application_api/Federate.hpp:570
helics::MessageFederate::getMessage
std::unique_ptr< Message > getMessage()
Definition: MessageFederate.cpp:281
helics::loadFederateInfo
FederateInfo loadFederateInfo(const std::string &configString)
Definition: FederateInfo.cpp:675
helics::Endpoint::subscribe
void subscribe(const std::string &key)
Definition: Endpoints.cpp:142
helicsMessageSetMessageID
void helicsMessageSetMessageID(HelicsMessage message, int32_t messageID, HelicsError *err)
Definition: MessageFederateExport.cpp:1040
helicsEndpointPendingMessageCount
int helicsEndpointPendingMessageCount(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:416
helics::MessageFederate::registerMessageInterfaces
void registerMessageInterfaces(const std::string &configString)
Definition: MessageFederate.cpp:144
helics::Federate::registerFilterInterfaces
void registerFilterInterfaces(const std::string &configString)
Definition: Federate.cpp:818
helicsMessageGetBytesPointer
void * helicsMessageGetBytesPointer(HelicsMessage message)
Definition: MessageFederateExport.cpp:952
helicsFederateCreateMessage
HelicsMessage helicsFederateCreateMessage(HelicsFederate fed, HelicsError *err)
Definition: MessageFederateExport.cpp:539
helicsMessageGetOriginalSource
const char * helicsMessageGetOriginalSource(HelicsMessage message)
Definition: MessageFederateExport.cpp:859
helicsEndpointSendMessageZeroCopy
void helicsEndpointSendMessageZeroCopy(HelicsEndpoint endpoint, HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:345
helicsEndpointSetOption
void helicsEndpointSetOption(HelicsEndpoint endpoint, int option, int value, HelicsError *err)
Definition: MessageFederateExport.cpp:723
helics::MessageFederate::registerGlobalEndpoint
Endpoint & registerGlobalEndpoint(const std::string &eptName, const std::string &type=std::string())
Definition: MessageFederate.cpp:126
HelicsFederate
void * HelicsFederate
Definition: api-data.h:60
helicsMessageGetByteCount
int helicsMessageGetByteCount(HelicsMessage message)
Definition: MessageFederateExport.cpp:919
helicsEndpointIsValid
HelicsBool helicsEndpointIsValid(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:186
helics::Federate::currentMode
std::atomic< Modes > currentMode
the current state of the simulation
Definition: application_api/Federate.hpp:77
helics::MessageFederate::subscribe
void subscribe(const Endpoint &ept, std::string_view key)
Definition: MessageFederate.cpp:244
helics::Time
TimeRepresentation< count_time< 9 > > Time
Definition: helicsTime.hpp:27
helicsFederateGetEndpointByIndex
HelicsEndpoint helicsFederateGetEndpointByIndex(HelicsFederate fed, int index, HelicsError *err)
Definition: MessageFederateExport.cpp:160
helicsMessageSetTime
void helicsMessageSetTime(HelicsMessage message, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:1003
helics::Endpoint
Definition: Endpoints.hpp:21
helics::Endpoint::addDestinationFilter
void addDestinationFilter(const std::string &filterName)
Definition: Endpoints.cpp:181
helicsMessageClone
HelicsMessage helicsMessageClone(HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:1133
helicsEndpointAddSourceTarget
void helicsEndpointAddSourceTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:739
helicsMessageGetFlagOption
HelicsBool helicsMessageGetFlagOption(HelicsMessage message, int flag)
Definition: MessageFederateExport.cpp:895
helics::MessageFederate
Definition: application_api/MessageFederate.hpp:22
helics::MessageFederate::getEndpoint
Endpoint & getEndpoint(const std::string &name) const
Definition: MessageFederate.cpp:297
helics::Federate::nameSegmentSeparator
char nameSegmentSeparator
the separator between automatically prependend names
Definition: application_api/Federate.hpp:78
helicsFederateClearMessages
void helicsFederateClearMessages(HelicsFederate fed)
Definition: MessageFederateExport.cpp:560
helicsEndpointAddSourceFilter
void helicsEndpointAddSourceFilter(HelicsEndpoint endpoint, const char *filterName, HelicsError *err)
Definition: MessageFederateExport.cpp:787
helics::getOptionIndex
int getOptionIndex(std::string val)
Definition: FederateInfo.cpp:385
helicsMessageGetTime
HelicsTime helicsMessageGetTime(HelicsMessage message)
Definition: MessageFederateExport.cpp:877
helics::MessageFederate::registerInterfaces
virtual void registerInterfaces(const std::string &configString) override
Definition: MessageFederate.cpp:138
helicsEndpointSendMessage
void helicsEndpointSendMessage(HelicsEndpoint endpoint, HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:327
helicsEndpointSetInfo
void helicsEndpointSetInfo(HelicsEndpoint endpoint, const char *info, HelicsError *err)
Definition: MessageFederateExport.cpp:658
helics::getOptionValue
int getOptionValue(std::string val)
Definition: FederateInfo.cpp:404
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:674
helics::InvalidParameter
Definition: core-exceptions.hpp:47
helics::MessageFederate::~MessageFederate
virtual ~MessageFederate()
helicsEndpointGetMessage
HelicsMessage helicsEndpointGetMessage(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:505
helicsMessageGetDestination
const char * helicsMessageGetDestination(HelicsMessage message)
Definition: MessageFederateExport.cpp:850
helicsMessageSetOriginalDestination
void helicsMessageSetOriginalDestination(HelicsMessage message, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:995
helics::MessageFederate::hasMessage
bool hasMessage() const
Definition: MessageFederate.cpp:249
helics::Endpoint::setDefaultDestination
void setDefaultDestination(std::string_view target)
Definition: Endpoints.cpp:128
helicsFederateHasMessage
HelicsBool helicsFederateHasMessage(HelicsFederate fed)
Definition: MessageFederateExport.cpp:389
helics::CoreApp
Definition: application_api/CoreApp.hpp:25
helicsEndpointGetOption
int helicsEndpointGetOption(HelicsEndpoint endpoint, int option)
Definition: MessageFederateExport.cpp:707
helics::MessageFederate::registerGlobalTargetedEndpoint
Endpoint & registerGlobalTargetedEndpoint(const std::string &eptName, const std::string &type=std::string())
Definition: MessageFederate.cpp:132
helicsMessageFree
void helicsMessageFree(HelicsMessage message)
Definition: MessageFederateExport.cpp:1157
helicsMessageAppendData
void helicsMessageAppendData(HelicsMessage message, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:1095
helics::FederateInfo
Definition: FederateInfo.hpp:20
helicsEndpointSendBytesAt
void helicsEndpointSendBytesAt(HelicsEndpoint endpoint, const void *data, int inputDataLength, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:284
helicsMessageIsValid
HelicsBool helicsMessageIsValid(HelicsMessage message)
Definition: MessageFederateExport.cpp:961
helicsFederateGetMessage
HelicsMessage helicsFederateGetMessage(HelicsFederate fed)
Definition: MessageFederateExport.cpp:521
helics::Federate::operator=
Federate & operator=(Federate &&fed) noexcept
Definition: Federate.cpp:190
helics::MessageFederate::setMessageNotificationCallback
void setMessageNotificationCallback(const std::function< void(Endpoint &, Time)> &callback)
helicsFederateGetEndpoint
HelicsEndpoint helicsFederateGetEndpoint(HelicsFederate fed, const char *name, HelicsError *err)
Definition: MessageFederateExport.cpp:133
helicsEndpointAddDestinationFilter
void helicsEndpointAddDestinationFilter(HelicsEndpoint endpoint, const char *filterName, HelicsError *err)
Definition: MessageFederateExport.cpp:803
helics::Federate::getID
auto getID() const noexcept
Definition: application_api/Federate.hpp:563
helicsFederateRegisterGlobalTargetedEndpoint
HelicsEndpoint helicsFederateRegisterGlobalTargetedEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:110
helics::Federate::Modes::INITIALIZING
@ INITIALIZING
helicsMessageSetOriginalSource
void helicsMessageSetOriginalSource(HelicsMessage message, const char *src, HelicsError *err)
Definition: MessageFederateExport.cpp:987
helicsMessageSetString
void helicsMessageSetString(HelicsMessage message, const char *str, HelicsError *err)
Definition: MessageFederateExport.cpp:1076
HelicsEndpoint
void * HelicsEndpoint
Definition: api-data.h:37
helicsMessageResize
void helicsMessageResize(HelicsMessage message, int newSize, HelicsError *err)
Definition: MessageFederateExport.cpp:1012
helics::IterationResult
IterationResult
Definition: CoreTypes.hpp:80
helicsMessageClear
void helicsMessageClear(HelicsMessage message, HelicsError *err)
Definition: MessageFederateExport.cpp:1104
helicsEndpointCreateMessage
HelicsMessage helicsEndpointCreateMessage(HelicsEndpoint endpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:548
helicsEndpointGetInfo
const char * helicsEndpointGetInfo(HelicsEndpoint end)
Definition: MessageFederateExport.cpp:641
helics::MessageFederate::initializeToExecuteStateTransition
virtual void initializeToExecuteStateTransition(IterationResult result) override
Definition: MessageFederate.cpp:99
helicsEndpointSendBytesToAt
void helicsEndpointSendBytesToAt(HelicsEndpoint endpoint, const void *data, int inputDataLength, const char *dst, HelicsTime time, HelicsError *err)
Definition: MessageFederateExport.cpp:302
helicsFederateRegisterGlobalEndpoint
HelicsEndpoint helicsFederateRegisterGlobalEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:90
helicsMessageGetString
const char * helicsMessageGetString(HelicsMessage message)
Definition: MessageFederateExport.cpp:908
helicsEndpointSendBytesTo
void helicsEndpointSendBytesTo(HelicsEndpoint endpoint, const void *data, int inputDataLength, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:266
helicsMessageReserve
void helicsMessageReserve(HelicsMessage message, int reserveSize, HelicsError *err)
Definition: MessageFederateExport.cpp:1026
HelicsMessage
void * HelicsMessage
Definition: api-data.h:84
helicsEndpointSubscribe
void helicsEndpointSubscribe(HelicsEndpoint endpoint, const char *key, HelicsError *err)
Definition: MessageFederateExport.cpp:372
helicsFederateRegisterTargetedEndpoint
HelicsEndpoint helicsFederateRegisterTargetedEndpoint(HelicsFederate fed, const char *name, const char *type, HelicsError *err)
Definition: MessageFederateExport.cpp:69
helics::MessageFederate::pendingMessageCount
uint64_t pendingMessageCount() const
Definition: MessageFederate.cpp:273
helicsEndpointRemoveTarget
void helicsEndpointRemoveTarget(HelicsEndpoint endpoint, const char *targetEndpoint, HelicsError *err)
Definition: MessageFederateExport.cpp:771
HelicsError
Definition: api-data.h:160
helicsMessageGetMessageID
int helicsMessageGetMessageID(HelicsMessage message)
Definition: MessageFederateExport.cpp:886
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:1058
helicsMessageSetSource
void helicsMessageSetSource(HelicsMessage message, const char *src, HelicsError *err)
Definition: MessageFederateExport.cpp:970
helicsFederatePendingMessageCount
int helicsFederatePendingMessageCount(HelicsFederate fed)
Definition: MessageFederateExport.cpp:407
helics::Federate::logWarningMessage
void logWarningMessage(const std::string &message) const
Definition: application_api/Federate.hpp:592
helicsEndpointSetDefaultDestination
void helicsEndpointSetDefaultDestination(HelicsEndpoint endpoint, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:195
helicsMessageSetDestination
void helicsMessageSetDestination(HelicsMessage message, const char *dst, HelicsError *err)
Definition: MessageFederateExport.cpp:979
helicsEndpointGetType
const char * helicsEndpointGetType(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:603
helicsEndpointGetName
const char * helicsEndpointGetName(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:621
helics::Endpoint::addSourceFilter
void addSourceFilter(const std::string &filterName)
Definition: Endpoints.cpp:174
helicsEndpointHasMessage
HelicsBool helicsEndpointHasMessage(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:398
helicsFederateGetEndpointCount
int helicsFederateGetEndpointCount(HelicsFederate fed)
Definition: MessageFederateExport.cpp:631
helics::Federate
Definition: application_api/Federate.hpp:47
helicsMessageGetBytes
void helicsMessageGetBytes(HelicsMessage message, void *data, int maxMessageLength, int *actualSize, HelicsError *err)
Definition: MessageFederateExport.cpp:928
helics::MessageFederate::getEndpointCount
int getEndpointCount() const
Definition: MessageFederate.cpp:324
helics::Interface::setTag
void setTag(const std::string &tag, const std::string &value)
Definition: Federate.cpp:1415
helics::Interface::setOption
virtual void setOption(int32_t option, int32_t value=1)
Definition: Federate.cpp:1425
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:89
helics::MessageFederate::startupToInitializeStateTransition
virtual void startupToInitializeStateTransition() override
Definition: MessageFederate.cpp:95
helicsEndpointGetDefaultDestination
const char * helicsEndpointGetDefaultDestination(HelicsEndpoint endpoint)
Definition: MessageFederateExport.cpp:212
helicsMessageSetData
void helicsMessageSetData(HelicsMessage message, const void *data, int inputDataLength, HelicsError *err)
Definition: MessageFederateExport.cpp:1086
helics::MessageFederate::localQuery
virtual std::string localQuery(const std::string &queryStr) const override
Definition: MessageFederate.cpp:104
HelicsBool
int HelicsBool
Definition: api-data.h:102
helics::Federate::disconnect
virtual void disconnect()
Definition: Federate.cpp:599