Add generic event rendezvous function block (GEN_E_REND)

This function block provides event synchronization for a configurable number of inputs. The count of event inputs (EI) is determined dynamically from the FB instance name (e.g., GEN_E_REND_3). An output event (EO) is fired once all EIs have been received, and a reset input (R) clears the internal state.

eclipse-4diac/4diac-ide#2087

Add tests for GEN_E_REND function blocks

Author: franz-hoepfinger-4diac

stdfblib/events/include/forte/iec61499/events/CMakeLists.txt

@@ -49,6 +49,7 @@ target_sources(forte-events PUBLIC
         GEN_E_DEMUX_fbt.h
         GEN_E_MUX_fbt.h
         GEN_E_MERGE_fbt.h
+        GEN_E_REND_fbt.h
         GEN_E_SPLIT_fbt.h
         timedfb.h
 )

stdfblib/events/include/forte/iec61499/events/GEN_E_REND_fbt.h

@@ -0,0 +1,84 @@
+/*******************************************************************************
+ * Copyright (c) 2026 HR Agartechnik GmbH
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Franz Höpfinger
+ *     - implement Generic GEN_E_REND_fbt
+ *******************************************************************************/
+
+// Some portions generated by Gemini CLI
+
+#pragma once
+
+#include <vector>
+#include "forte/genfb.h"
+#include "forte/stringid.h"
+
+namespace forte::iec61499::events {
+  /**
+   * @brief A generic function block for event rendezvous (synchronization).
+   *
+   * The number of event inputs is determined by the instance name, e.g., an instance
+   * named "GEN_E_REND_3" will have 3 synchronization inputs (EI1, EI2, EI3) and one Reset input (R).
+   * The output EO is fired only after all EI inputs have been received.
+   */
+  class GEN_E_REND final : public CGenFunctionBlock<CFunctionBlock> {
+      DECLARE_GENERIC_FIRMWARE_FB(GEN_E_REND)
+
+    private:
+      /**
+       * @brief Executes when an event is received.
+       *
+       * @param paEIID The ID of the input event that triggered the execution.
+       * @param paECET The event chain execution thread.
+       */
+      void executeEvent(TEventID paEIID, CEventChainExecutionThread *const paECET) override;
+
+      /** These functions are not needed as this FB has no data inputs/outputs. */
+      void readInputData(TEventID paEIID) override;
+      void writeOutputData(TEventID paEIID) override;
+
+      /**
+       * @brief Creates the interface specification based on the configuration string.
+       *
+       * It parses the number from the end of the config string (e.g., "3" from "GEN_E_REND_3")
+       * to determine the number of event inputs.
+       * @param paConfigString The configuration string (typically the FB instance name).
+       * @param paInterfaceSpec The interface specification structure to be filled.
+       * @return true on success, false otherwise.
+       */
+      bool createInterfaceSpec(const char *paConfigString, SFBInterfaceSpec &paInterfaceSpec) override;
+
+      /** A vector to hold the dynamically generated StringIds for the event input names. */
+      std::vector<StringId> mEventInputNames;
+
+      /**
+       * @brief Tracks which events have been received.
+       * mFlags[i] corresponds to EI(i+1).
+       */
+      std::vector<bool> mFlags;
+
+      /**
+       * @brief Number of synchronization inputs (excluding R).
+       * Set during configuration.
+       */
+      size_t mNumEIs;
+
+    public:
+      GEN_E_REND(StringId paInstanceNameId, CFBContainer &paContainer);
+
+      CEventConnection conn_EO;
+
+      CIEC_ANY *getDI(size_t) override;
+      CIEC_ANY *getDO(size_t) override;
+      CEventConnection *getEOConUnchecked(TPortId) override;
+      CDataConnection **getDIConUnchecked(TPortId) override;
+      CDataConnection *getDOConUnchecked(TPortId) override;
+  };
+} // namespace forte::iec61499::events

stdfblib/events/src/CMakeLists.txt

@@ -47,6 +47,7 @@ target_sources(forte-events PRIVATE
         GEN_E_DEMUX_fbt.cpp
         GEN_E_MUX_fbt.cpp
         GEN_E_MERGE_fbt.cpp
+        GEN_E_REND_fbt.cpp
         GEN_E_SPLIT_fbt.cpp
         timedfb.cpp
 )

stdfblib/events/src/GEN_E_REND_fbt.cpp

@@ -0,0 +1,139 @@
+/*******************************************************************************
+ * Copyright (c) 2026 HR Agartechnik GmbH
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Franz Höpfinger
+ *     - implement Generic GEN_E_REND_fbt
+ *******************************************************************************/
+
+// Some portions generated by Gemini CLI
+
+#include "forte/iec61499/events/GEN_E_REND_fbt.h"
+#include "forte/util/string_utils.h"
+
+using namespace forte::literals;
+
+namespace forte::iec61499::events {
+  // Registers the generic FB with the name "GEN_E_REND" in the FORTE type library.
+  DEFINE_GENERIC_FIRMWARE_FB(GEN_E_REND, "iec61499::events::GEN_E_REND"_STRID)
+
+  namespace {
+    // Defines the constant name for the single event output.
+    const auto cEventOutputNames = std::array{"EO"_STRID};
+  } // namespace
+
+  GEN_E_REND::GEN_E_REND(const StringId paInstanceNameId, CFBContainer &paContainer) :
+      CGenFunctionBlock<CFunctionBlock>(paContainer, paInstanceNameId),
+      mNumEIs(0),
+      conn_EO(*this, 0) {
+  }
+
+  void GEN_E_REND::executeEvent(const TEventID paEIID, CEventChainExecutionThread *const paECET) {
+    if (paEIID == mNumEIs) {
+      // This is the R (Reset) event
+      std::fill(mFlags.begin(), mFlags.end(), false);
+    } else if (paEIID < mNumEIs) {
+      // This is one of the EI inputs
+      mFlags[paEIID] = true;
+
+      // Check if all inputs have been received
+      bool allReceived = true;
+      for (bool received : mFlags) {
+        if (!received) {
+          allReceived = false;
+          break;
+        }
+      }
+
+      if (allReceived) {
+        // Send EO
+        sendOutputEvent(0, paECET);
+        // Reset flags after rendezvous
+        std::fill(mFlags.begin(), mFlags.end(), false);
+      }
+    }
+  }
+
+  void GEN_E_REND::readInputData(TEventID) {
+    // Nothing to do, as there are no data inputs.
+  }
+
+  void GEN_E_REND::writeOutputData(TEventID) {
+    // Nothing to do, as there are no data outputs.
+  }
+
+  bool GEN_E_REND::createInterfaceSpec(const char *paConfigString, SFBInterfaceSpec &paInterfaceSpec) {
+    // Find the last underscore in the name, e.g., "E_REND_3".
+    const char *acPos = strrchr(paConfigString, '_');
+
+    if (nullptr != acPos) {
+      ++acPos; // Move pointer to the character after the underscore.
+
+      // Convert the numeric part to an integer. This is the number of EI inputs.
+      mNumEIs = static_cast<size_t>(util::strtoul(acPos, nullptr, 10));
+
+      // Check if the number of inputs is within the valid range.
+      // E_REND needs at least 2 inputs. scmMaxInterfaceEvents is the hard limit.
+      // We add 1 for R, so mNumEIs + 1 must be <= scmMaxInterfaceEvents.
+      if (mNumEIs >= 2 && (mNumEIs + 1) < scmMaxInterfaceEvents) {
+
+        // Resize flags vector to match number of inputs
+        mFlags.resize(mNumEIs, false);
+
+        mEventInputNames.clear();
+        // Generate names "EI1", "EI2", etc.
+        generateGenericInterfacePointNameArray("EI", mEventInputNames, mNumEIs);
+
+        // Add the Reset input "R"
+        mEventInputNames.push_back("R"_STRID);
+
+        // Assign the generated input names and the constant output name to the interface.
+        paInterfaceSpec.mEINames = mEventInputNames;
+        paInterfaceSpec.mEONames = cEventOutputNames;
+
+        return true; // Success
+      } else {
+        // Log errors if the number is out of bounds.
+        if ((mNumEIs + 1) >= scmMaxInterfaceEvents) {
+          DEVLOG_ERROR("Cannot configure FB-Instance GEN_E_REND_%d. Number of event inputs exceeds maximum of %d.\n",
+                       mNumEIs, CFunctionBlock::scmMaxInterfaceEvents - 1);
+        } else {
+          DEVLOG_ERROR(
+              "Cannot configure FB-Instance GEN_E_REND_%d. Number of event inputs smaller than minimum of 2.\n",
+              mNumEIs);
+        }
+      }
+    }
+    return false; // Failure
+  }
+
+  // The following functions return nullptr because this FB does not handle data.
+  CIEC_ANY *GEN_E_REND::getDI(size_t) {
+    return nullptr;
+  }
+
+  CIEC_ANY *GEN_E_REND::getDO(size_t) {
+    return nullptr;
+  }
+
+  CEventConnection *GEN_E_REND::getEOConUnchecked(const TPortId paIndex) {
+    switch (paIndex) {
+      case 0: return &conn_EO;
+    }
+    return nullptr;
+  }
+
+  CDataConnection **GEN_E_REND::getDIConUnchecked(TPortId) {
+    return nullptr;
+  }
+
+  CDataConnection *GEN_E_REND::getDOConUnchecked(TPortId) {
+    return nullptr;
+  }
+} // namespace forte::iec61499::events

tests/stdfblib/events/CMakeLists.txt

@@ -29,5 +29,8 @@ forte_test_add_sourcefile_cpp(E_CTD_tester.cpp)
 forte_test_add_sourcefile_cpp(E_CTU_tester.cpp)
 forte_test_add_sourcefile_cpp(E_CTUD_tester.cpp)
 forte_test_add_sourcefile_cpp(E_REND_tester.cpp)
+forte_test_add_sourcefile_cpp(GEN_E_REND_2_tester.cpp)
+forte_test_add_sourcefile_cpp(GEN_E_REND_3_tester.cpp)
+forte_test_add_sourcefile_cpp(GEN_E_REND_4_tester.cpp)
 
 

tests/stdfblib/events/GEN_E_REND_2_tester.cpp

@@ -0,0 +1,73 @@
+/*******************************************************************************
+ * Copyright (c) 2026 HR Agartechnik GmbH
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Franz Höpfinger
+ *     - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+
+#include "../../core/fbtests/fbtestfixture.h"
+
+using namespace forte::literals;
+
+namespace forte::iec61499::events::test {
+  struct GEN_E_REND_2_TestFixture : public forte::test::CFBTestFixtureBase {
+      GEN_E_REND_2_TestFixture() : CFBTestFixtureBase("iec61499::events::E_REND_2"_STRID) {
+        setup();
+      }
+
+      static constexpr TEventID EI1 = 0;
+      static constexpr TEventID EI2 = 1;
+      static constexpr TEventID R = 2;
+      static constexpr TEventID EO = 0;
+  };
+
+  BOOST_FIXTURE_TEST_SUITE(GenERend2Tests, GEN_E_REND_2_TestFixture)
+
+  BOOST_AUTO_TEST_CASE(Rendezvous2) {
+    triggerEvent(EI1);
+    BOOST_CHECK(eventChainEmpty());
+    triggerEvent(EI2);
+    BOOST_CHECK(checkForSingleOutputEventOccurence(EO));
+  }
+
+  BOOST_AUTO_TEST_CASE(Rendezvous2_OutOfOrder) {
+    triggerEvent(EI2);
+    BOOST_CHECK(eventChainEmpty());
+    triggerEvent(EI1);
+    BOOST_CHECK(checkForSingleOutputEventOccurence(EO));
+  }
+
+  BOOST_AUTO_TEST_CASE(Reset) {
+    triggerEvent(EI1);
+    BOOST_CHECK(eventChainEmpty());
+
+    triggerEvent(R);
+    BOOST_CHECK(eventChainEmpty());
+
+    // After reset EI1 alone must not fire EO
+    triggerEvent(EI1);
+    BOOST_CHECK(eventChainEmpty());
+
+    // Now both together
+    triggerEvent(EI2);
+    BOOST_CHECK(checkForSingleOutputEventOccurence(EO));
+  }
+
+  BOOST_AUTO_TEST_CASE(MultipleRendezvous) {
+    for (int i = 0; i < 5; i++) {
+      triggerEvent(EI1);
+      BOOST_CHECK(eventChainEmpty());
+      triggerEvent(EI2);
+      BOOST_CHECK(checkForSingleOutputEventOccurence(EO));
+    }
+  }
+
+  BOOST_AUTO_TEST_SUITE_END()
+} // namespace forte::iec61499::events::test