helics  2.8.1
cpp98/MessageFederate.hpp
1 /*
2 Copyright (c) 2017-2021,
3 Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable
4 Energy, LLC. See the top-level NOTICE for additional details. All rights reserved.
5 SPDX-License-Identifier: BSD-3-Clause
6 */
7 
8 #ifndef HELICS_CPP98_MESSAGE_FEDERATE_HPP_
9 #define HELICS_CPP98_MESSAGE_FEDERATE_HPP_
10 #pragma once
11 
12 #include "../shared_api_library/MessageFederate.h"
13 #include "Endpoint.hpp"
14 #include "Federate.hpp"
15 
16 #include <string>
17 #include <vector>
18 
19 namespace helicscpp {
22 class MessageFederate: public virtual Federate {
23  public:
28  MessageFederate(const std::string& fedName, FederateInfo& fi)
29  {
30  fed = helicsCreateMessageFederate(fedName.c_str(), fi.getInfo(), hThrowOnError());
31  }
32 
36  explicit MessageFederate(const std::string& configString)
37  {
38  fed = helicsCreateMessageFederateFromConfig(configString.c_str(), hThrowOnError());
39  }
40 
42  MessageFederate() HELICS_NOTHROW {}
43 
52  Endpoint registerEndpoint(const std::string& name, const std::string& type = std::string())
53  {
54  helics_endpoint ep =
55  helicsFederateRegisterEndpoint(fed, name.c_str(), type.c_str(), hThrowOnError());
56  local_endpoints.push_back(ep);
57  return Endpoint(ep);
58  }
59 
65  Endpoint registerGlobalEndpoint(const std::string& name,
66  const std::string& type = std::string())
67  {
68  helics_endpoint ep =
69  helicsFederateRegisterGlobalEndpoint(fed, name.c_str(), type.c_str(), hThrowOnError());
70  local_endpoints.push_back(ep);
71  return Endpoint(ep);
72  }
73 
77  Endpoint getEndpoint(const std::string& name)
78  {
79  return Endpoint(helicsFederateGetEndpoint(fed, name.c_str(), hThrowOnError()));
80  }
84  Endpoint getEndpoint(int index)
85  {
87  }
88 
90  bool hasMessage() const
91  {
92  // returns int, 1 = true, 0 = false
93  return (helicsFederateHasMessage(fed) > 0);
94  }
95 
98 
101 
104  {
106  }
109 
110  private:
111  std::vector<helics_endpoint> local_endpoints;
112 };
113 // this code needs the definition of federate before it can de defined
116 {
117 }
118 
120 {
121  helics_message_object newmo =
123  if (mo != HELICS_NULL_POINTER) {
124  helicsMessageFree(mo);
125  }
126  mo = newmo;
127  return *this;
128 }
129 } // namespace helicscpp
130 #endif
helicscpp::MessageFederate::MessageFederate
MessageFederate(const std::string &fedName, FederateInfo &fi)
Definition: cpp98/MessageFederate.hpp:28
helicsFederatePendingMessageCount
int helicsFederatePendingMessageCount(helics_federate fed)
Definition: MessageFederateExport.cpp:356
helicscpp::Message
Definition: Endpoint.hpp:21
helicsFederateHasMessage
helics_bool helicsFederateHasMessage(helics_federate fed)
Definition: MessageFederateExport.cpp:338
helicscpp::MessageFederate::pendingMessages
int pendingMessages() const
Definition: cpp98/MessageFederate.hpp:97
helicsFederateGetEndpointByIndex
helics_endpoint helicsFederateGetEndpointByIndex(helics_federate fed, int index, helics_error *err)
Definition: MessageFederateExport.cpp:119
helicscpp::MessageFederate
Definition: cpp98/MessageFederate.hpp:22
helicsCreateMessageFederateFromConfig
helics_federate helicsCreateMessageFederateFromConfig(const char *configFile, helics_error *err)
Definition: FederateExport.cpp:454
helicsFederateRegisterEndpoint
helics_endpoint helicsFederateRegisterEndpoint(helics_federate fed, const char *name, const char *type, helics_error *err)
Definition: MessageFederateExport.cpp:48
helics_message_object
void * helics_message_object
Definition: api-data.h:76
helicscpp::Federate
Definition: cpp98/Federate.hpp:186
helicscpp::FederateInfo
Definition: cpp98/Federate.hpp:29
helicscpp::MessageFederate::hasMessage
bool hasMessage() const
Definition: cpp98/MessageFederate.hpp:90
helicsFederateRegisterGlobalEndpoint
helics_endpoint helicsFederateRegisterGlobalEndpoint(helics_federate fed, const char *name, const char *type, helics_error *err)
Definition: MessageFederateExport.cpp:69
helicscpp::MessageFederate::MessageFederate
MessageFederate() HELICS_NOTHROW
Definition: cpp98/MessageFederate.hpp:42
helicscpp::MessageFederate::MessageFederate
MessageFederate(const std::string &configString)
Definition: cpp98/MessageFederate.hpp:36
helicsFederateCreateMessageObject
helics_message_object helicsFederateCreateMessageObject(helics_federate fed, helics_error *err)
Definition: MessageFederateExport.cpp:565
helicscpp::FederateInfo::getInfo
helics_federate_info getInfo()
Definition: cpp98/Federate.hpp:156
helicscpp::MessageFederate::getMessage
Message getMessage()
Definition: cpp98/MessageFederate.hpp:100
helicscpp::MessageFederate::registerGlobalEndpoint
Endpoint registerGlobalEndpoint(const std::string &name, const std::string &type=std::string())
Definition: cpp98/MessageFederate.hpp:65
helics_endpoint
void * helics_endpoint
Definition: api-data.h:36
fed
@ fed
special logging command for message coming from a fed
Definition: loggingHelper.hpp:32
helicscpp::MessageFederate::createMessage
Message createMessage()
Definition: cpp98/MessageFederate.hpp:103
helicscpp::hThrowOnError
Definition: helicsExceptions.hpp:38
helicscpp::Endpoint
Definition: Endpoint.hpp:197
helicscpp::Federate::fed
helics_federate fed
underlying helics_federate object
Definition: cpp98/Federate.hpp:662
helicscpp::MessageFederate::registerEndpoint
Endpoint registerEndpoint(const std::string &name, const std::string &type=std::string())
Definition: cpp98/MessageFederate.hpp:52
helicsFederateGetEndpoint
helics_endpoint helicsFederateGetEndpoint(helics_federate fed, const char *name, helics_error *err)
Definition: MessageFederateExport.cpp:92
helicscpp::MessageFederate::getEndpointCount
int getEndpointCount() const
Definition: cpp98/MessageFederate.hpp:108
helicscpp::Message::Message
Message() HELICS_NOTHROW
Definition: Endpoint.hpp:24
helicsMessageFree
void helicsMessageFree(helics_message_object message)
Definition: MessageFederateExport.cpp:1066
helicsFederateGetEndpointCount
int helicsFederateGetEndpointCount(helics_federate fed)
Definition: MessageFederateExport.cpp:657
helicscpp::MessageFederate::getEndpoint
Endpoint getEndpoint(int index)
Definition: cpp98/MessageFederate.hpp:84
helicsFederateGetMessageObject
helics_message_object helicsFederateGetMessageObject(helics_federate fed)
Definition: MessageFederateExport.cpp:547
helicscpp::MessageFederate::getEndpoint
Endpoint getEndpoint(const std::string &name)
Definition: cpp98/MessageFederate.hpp:77
helicscpp
Definition: cpp98/Broker.hpp:18
helicsCreateMessageFederate
helics_federate helicsCreateMessageFederate(const char *fedName, helics_federate_info fi, helics_error *err)
Definition: FederateExport.cpp:428
helicscpp::Message::newMessageObject
Message & newMessageObject(const Federate &fed)
Definition: cpp98/MessageFederate.hpp:119