Update to use HELICS 0.9 filter API

contrib/helics/model/helics-application.cc

@@ -126,10 +126,10 @@ HelicsApplication::SetFilterName (const std::string &name)
   Names::Add("helics_filter_"+name, this);
   m_filter_id = helics_federate->registerSourceFilter ("ns3_"+name, name);
   using std::placeholders::_1;
-  using std::placeholders::_2;
-  std::function<void(helics::filter_id_t,helics::Time)> func;
-  func = std::bind (&HelicsApplication::FilterCallback, this, _1, _2);
-  helics_federate->registerFilterCallback(m_filter_id, func);
+  std::function<void(std::unique_ptr<helics::Message>)> func;
+  func = std::bind (&HelicsApplication::FilterCallback, this, _1);
+  m_filterOp = std::make_shared<Ns3Operator> (func);
+  helics_federate->setFilterOperator (m_filter_id, m_filterOp);
 }
 
 void
@@ -251,26 +251,23 @@ HelicsApplication::NewTag ()
 }
 
 void 
-HelicsApplication::FilterCallback (helics::filter_id_t id, helics::Time time)
+HelicsApplication::FilterCallback (std::unique_ptr<helics::Message> message)
 {
   NS_LOG_FUNCTION (this << "Helics filter callback");
 
   Ptr<Packet> p;
 
-  // Get the helics Message.
-  auto m = helics_federate->getMessageToFilter (id);
-
   // Find the HelicsApplication for the destination.
-  Ptr<HelicsApplication> to = Names::Find<HelicsApplication>("helics_"+m->dest);
+  Ptr<HelicsApplication> to = Names::Find<HelicsApplication>("helics_"+message->dest);
   if (!to) {
-    NS_FATAL_ERROR("failed HelicsApplication lookup to '" << m->dest << "'");
+    NS_FATAL_ERROR("failed HelicsApplication lookup to '" << message->dest << "'");
   }
 
   // Convert given Message into a Packet.
-  size_t total_size = m->data.size();
+  size_t total_size = message->data.size();
   uint8_t *buffer = new uint8_t[total_size];
   uint8_t *buffer_ptr = buffer;
-  std::transform (m->data.begin(), m->data.end(), buffer_ptr, char_to_uint8_t);
+  std::transform (message->data.begin(), message->data.end(), buffer_ptr, char_to_uint8_t);
   p = Create<Packet> (buffer, total_size);
   NS_LOG_INFO("buffer='" << p << "'");
   delete [] buffer;
@@ -282,7 +279,7 @@ HelicsApplication::FilterCallback (helics::filter_id_t id, helics::Time time)
   p->AddPacketTag(tag);
 
   // Store the Message at the destination application for later sending.
-  to->m_messages.insert(std::make_pair(tag, std::move (m)));
+  to->m_messages.insert(std::make_pair(tag, std::move (message)));
 
   // call to the trace sinks before the packet is actually sent,
   // so that tags added to the packet can be sent as well
@@ -473,4 +470,23 @@ HelicsApplication::HandleRead (Ptr<Socket> socket)
     }
 }
 
+/** HELICS message FilterOperator for ns3 */
+
+HelicsApplication::Ns3Operator::Ns3Operator (std::function<void(std::unique_ptr<helics::Message> message)> cb)
+{
+  setFilterCallback (cb);
+}
+
+void
+HelicsApplication::Ns3Operator::setFilterCallback (std::function<void(std::unique_ptr<helics::Message> message)> cb)
+{
+  filterCallback = cb;
+}
+
+std::unique_ptr<helics::Message>
+HelicsApplication::Ns3Operator::process (std::unique_ptr<helics::Message> message)
+{
+  return nullptr;
+}
+
 } // Namespace ns3

contrib/helics/model/helics-application.h

@@ -45,7 +45,7 @@ class Inet6SocketAddress;
  *
  * Every packet sent should be returned by the server and received here.
  */
-class HelicsApplication : public Application 
+class HelicsApplication : public Application
 {
 public:
   /**
@@ -103,7 +103,7 @@ class HelicsApplication : public Application
    *
    * This function is called internally by HELICS.
    */
-  void FilterCallback (helics::filter_id_t id, helics::Time time);
+  void FilterCallback (std::unique_ptr<helics::Message> message);
 
   /**
    * \brief Receive a HELICS message.
@@ -151,6 +151,22 @@ class HelicsApplication : public Application
   helics::filter_id_t m_filter_id;
   helics::endpoint_id_t m_endpoint_id;
   std::map<uint32_t,std::unique_ptr<helics::Message> > m_messages;
+
+  class Ns3Operator : public helics::FilterOperator
+  {
+  public:
+    /** default constructor */
+    Ns3Operator () = default;
+    /** set the filter callback function in the constructor */
+    Ns3Operator (std::function<void(std::unique_ptr<helics::Message> message)> cb);
+    /** set the filter callback function */
+    void setFilterCallback (std::function<void(std::unique_ptr<helics::Message> message)> cb);
+  private:
+    std::function<void(std::unique_ptr<helics::Message> message)> filterCallback; //!<the filter callback function
+    virtual std::unique_ptr<helics::Message> process (std::unique_ptr<helics::Message> message) override;
+  };
+
+  std::shared_ptr<Ns3Operator> m_filterOp; //!< the filter operator for this application
 };
 
 } // namespace ns3