[Core]: Add event dispatcher as more maintainable way of handling cal…

…lbacks

Apply the event dispatcher to VT events

CMakeLists.txt

@@ -116,7 +116,8 @@ if(BUILD_TESTING)
       test/vt_client_tests.cpp
       test/language_command_interface_tests.cpp
       test/tc_client_tests.cpp
-      test/ddop_tests.cpp)
+      test/ddop_tests.cpp
+      test/event_dispatcher_tests.cpp)
 
   add_executable(unit_tests ${TEST_SRC})
   target_link_libraries(

examples/virtual_terminal/aux_functions/main.cpp

@@ -3,6 +3,7 @@
 #include "isobus/isobus/can_general_parameter_group_numbers.hpp"
 #include "isobus/isobus/can_network_manager.hpp"
 #include "isobus/isobus/can_partnered_control_function.hpp"
+#include "isobus/isobus/can_stack_logger.hpp"
 #include "isobus/isobus/isobus_virtual_terminal_client.hpp"
 #include "isobus/utility/iop_file_interface.hpp"
 
@@ -34,9 +35,9 @@ void raw_can_glue(isobus::HardwareInterfaceCANFrame &rawFrame, void *parentPoint
 }
 
 // This callback will provide us with event driven notifications of auxiliary input from the stack
-void handle_aux_input(isobus::VirtualTerminalClient::AssignedAuxiliaryFunction function, std::uint16_t value1, std::uint16_t value2, isobus::VirtualTerminalClient *)
+void handle_aux_function_input(const isobus::VirtualTerminalClient::AuxiliaryFunctionEvent &event)
 {
-	std::cout << "Auxiliary function event received: (" << function.functionObjectID << ", " << function.inputObjectID << ", " << static_cast<int>(function.functionType) << "), value1: " << value1 << ", value2: " << value2 << std::endl;
+	std::cout << "Auxiliary function event received: (" << event.function.functionObjectID << ", " << event.function.inputObjectID << ", " << static_cast<int>(event.function.functionType) << "), value1: " << event.value1 << ", value2: " << event.value2 << std::endl;
 }
 
 int main()
@@ -107,12 +108,12 @@ int main()
 
 	const isobus::NAMEFilter filterVirtualTerminal(isobus::NAME::NAMEParameters::FunctionCode, static_cast<std::uint8_t>(isobus::NAME::Function::VirtualTerminal));
 	const std::vector<isobus::NAMEFilter> vtNameFilters = { filterVirtualTerminal };
-	std::shared_ptr<isobus::InternalControlFunction> TestInternalECU = std::make_shared<isobus::InternalControlFunction>(TestDeviceNAME, 0x1D, 0);
-	std::shared_ptr<isobus::PartneredControlFunction> TestPartnerVT = std::make_shared<isobus::PartneredControlFunction>(0, vtNameFilters);
+	auto TestInternalECU = std::make_shared<isobus::InternalControlFunction>(TestDeviceNAME, 0x1D, 0);
+	auto TestPartnerVT = std::make_shared<isobus::PartneredControlFunction>(0, vtNameFilters);
 
 	TestVirtualTerminalClient = std::make_shared<isobus::VirtualTerminalClient>(TestPartnerVT, TestInternalECU);
 	TestVirtualTerminalClient->set_object_pool(0, isobus::VirtualTerminalClient::VTVersion::Version3, testPool.data(), testPool.size(), objectPoolHash);
-	TestVirtualTerminalClient->register_auxiliary_function_event_callback(handle_aux_input);
+	auto auxFunctionListener = TestVirtualTerminalClient->add_auxiliary_function_event_listener(handle_aux_function_input);
 	TestVirtualTerminalClient->initialize(true);
 
 	while (running)

examples/virtual_terminal/aux_inputs/main.cpp

@@ -99,12 +99,6 @@ void raw_can_glue(isobus::HardwareInterfaceCANFrame &rawFrame, void *parentPoint
 	isobus::CANNetworkManager::CANNetwork.can_lib_process_rx_message(rawFrame, parentPointer);
 }
 
-// This callback will provide us with event driven notifications of auxiliary input from the stack
-void handle_aux_input(isobus::VirtualTerminalClient::AssignedAuxiliaryFunction function, std::uint16_t value1, std::uint16_t value2, isobus::VirtualTerminalClient *)
-{
-	std::cout << "Auxiliary function event received: (" << function.functionObjectID << ", " << function.inputObjectID << ", " << static_cast<int>(function.functionType) << "), value1: " << value1 << ", value2: " << value2 << std::endl;
-}
-
 int main()
 {
 	std::signal(SIGINT, signal_handler);

examples/virtual_terminal/version3_object_pool/main.cpp

@@ -12,6 +12,7 @@
 
 #include <atomic>
 #include <csignal>
+#include <functional>
 #include <iostream>
 #include <memory>
 
@@ -35,15 +36,15 @@ void raw_can_glue(isobus::HardwareInterfaceCANFrame &rawFrame, void *parentPoint
 }
 
 // This callback will provide us with event driven notifications of button presses from the stack
-void handleVTButton(isobus::VirtualTerminalClient::KeyActivationCode keyEvent, std::uint8_t, std::uint16_t objectID, std::uint16_t, isobus::VirtualTerminalClient *)
+void handleVTKeyEvents(const isobus::VirtualTerminalClient::VTKeyEvent &event)
 {
 	static std::uint32_t exampleNumberOutput = 214748364; // In the object pool the output number has an offset of -214748364 so we use this to represent 0.
 
-	switch (keyEvent)
+	switch (event.keyEvent)
 	{
 		case isobus::VirtualTerminalClient::KeyActivationCode::ButtonUnlatchedOrReleased:
 		{
-			switch (objectID)
+			switch (event.objectID)
 			{
 				case Plus_Button:
 				{
@@ -152,8 +153,8 @@ int main()
 
 	TestVirtualTerminalClient = std::make_shared<isobus::VirtualTerminalClient>(TestPartnerVT, TestInternalECU);
 	TestVirtualTerminalClient->set_object_pool(0, isobus::VirtualTerminalClient::VTVersion::Version3, testPool.data(), testPool.size(), objectPoolHash);
-	TestVirtualTerminalClient->register_vt_button_event_callback(handleVTButton);
-	TestVirtualTerminalClient->register_vt_soft_key_event_callback(handleVTButton);
+	auto softKeyListener = TestVirtualTerminalClient->add_vt_soft_key_event_listener(handleVTKeyEvents);
+	auto buttonListener = TestVirtualTerminalClient->add_vt_button_event_listener(handleVTKeyEvents);
 	TestVirtualTerminalClient->initialize(true);
 
 	while (running)

hardware_integration/src/innomaker_usb2can_windows_plugin.cpp

@@ -13,6 +13,7 @@
 
 #include "isobus/hardware_integration/innomaker_usb2can_windows_plugin.hpp"
 #include "isobus/isobus/can_stack_logger.hpp"
+#include "isobus/utility/to_string.hpp"
 
 #include <thread>