Add get_name method to the CANHardwarePlugin

Author: martonmiklos

hardware_integration/include/isobus/hardware_integration/can_hardware_plugin.hpp

@@ -9,6 +9,7 @@
 #ifndef CAN_HARDEWARE_PLUGIN_HPP
 #define CAN_HARDEWARE_PLUGIN_HPP
 
+#include <string>
 #include "isobus/isobus/can_message_frame.hpp"
 
 namespace isobus
@@ -23,6 +24,11 @@ namespace isobus
 	public:
 		virtual ~CANHardwarePlugin() = default;
 
+		/// @brief Returns with the name of the plugin in a format which is suitable to be displayed
+		/// to the user for e.g. on a ComboBox
+		/// @returns the name of the plugin
+		virtual std::string get_name() const = 0;
+
 		/// @brief Returns if the driver is ready and in a good state
 		/// @details This should return `false` until `open` is called, and after `close` is called, or
 		/// if anything happens that causes the driver to be invalid, like the hardware is disconnected.

hardware_integration/include/isobus/hardware_integration/flex_can_t4_plugin.hpp

@@ -27,6 +27,10 @@ namespace isobus
 		/// @brief The destructor for FlexCANT4Plugin
 		virtual ~FlexCANT4Plugin() = default;
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns FlexCANT4
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;

hardware_integration/include/isobus/hardware_integration/innomaker_usb2can_windows_plugin.hpp

@@ -59,6 +59,10 @@ namespace isobus
 		/// @brief The destructor for InnoMakerUSB2CANWindowsPlugin
 		virtual ~InnoMakerUSB2CANWindowsPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns INNO-Maker USB2CAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;

hardware_integration/include/isobus/hardware_integration/mac_can_pcan_plugin.hpp

@@ -34,6 +34,10 @@ namespace isobus
 		/// @brief The destructor for MacCANPCANPlugin
 		virtual ~MacCANPCANPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns MacCAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;

hardware_integration/include/isobus/hardware_integration/mcp2515_can_interface.hpp

@@ -39,6 +39,10 @@ namespace isobus
 		/// @brief The destructor for SocketCANInterface
 		virtual ~MCP2515CANInterface();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns MCP2515
+		std::string get_name() const override;
+
 		/// @brief Returns if the socket connection is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;

hardware_integration/include/isobus/hardware_integration/ntcan_plugin.hpp

@@ -30,6 +30,10 @@ namespace isobus
 		/// @param[in] baudrate The baudrate to use for the CAN connection.
 		explicit NTCANPlugin(int channel, int baudrate = NTCAN_BAUD_250);
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns ESD NTCAN
+		std::string get_name() const override;
+
 		/// @brief The destructor for NTCANPlugin
 		virtual ~NTCANPlugin() = default;
 

hardware_integration/include/isobus/hardware_integration/pcan_basic_windows_plugin.hpp

@@ -39,6 +39,10 @@ namespace isobus
 		/// @brief The destructor for PCANBasicWindowsPlugin
 		virtual ~PCANBasicWindowsPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns PEAK CAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;

hardware_integration/include/isobus/hardware_integration/socket_can_interface.hpp

@@ -35,6 +35,10 @@ namespace isobus
 		/// @brief The destructor for SocketCANInterface
 		virtual ~SocketCANInterface();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns SocketCAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the socket connection is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;

hardware_integration/include/isobus/hardware_integration/sys_tec_windows_plugin.hpp

@@ -41,6 +41,10 @@ namespace isobus
 		/// @brief The destructor for PCANBasicWindowsPlugin
 		virtual ~SysTecWindowsPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns SYS TEC
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;

hardware_integration/include/isobus/hardware_integration/toucan_vscp_canal.hpp

@@ -43,6 +43,10 @@ namespace isobus
 		/// @brief The destructor for TouCANPlugin
 		virtual ~TouCANPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns Rusoku TouCAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;