X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fconfiguration.hpp;h=77f452ff9cf5cfa398ff3742b5f709661dbc18ba;hb=c3a5d22eae9df8eaf4773e0df0cdacdbeb634496;hp=13f420084c6eb61325a684760d8541657471ef98;hpb=99105e3efca6824e6499cad85df1244c7173ef5e;p=apps%2Flow-level-can-service.git

diff --git a/src/configuration.hpp b/src/configuration.hpp
index 13f4200..77f452f 100644
--- a/src/configuration.hpp
+++ b/src/configuration.hpp
@@ -46,68 +46,62 @@ class configuration_t
 		uint8_t active_message_set_ = 0;
 
 	public:
+		configuration_t();
+
 		const std::vector<obd2_signal_t> obd2_signals_;
 		const std::vector<can_message_set_t> can_message_set_;
 		const std::vector<std::vector<can_signal_t>> can_signals_;
 		const std::vector<std::vector<can_message_definition_t>> can_message_definition_;
 
-		configuration_t& get_configuration()
-		{ 
-			return *this;
-		}
-
-		can_bus_t& get_can_bus_manager()
-		{
-			return can_bus_manager_;
-		}
-
-		diagnostic_manager_t& get_diagnostic_manager()
-		{
-			return diagnostic_manager_;
-		}
-
-		uint8_t get_active_message_set()
-		{
-			return active_message_set_;
-		}
-
-		const std::vector<can_message_set_t>& get_can_message_set()
-		{
-			return can_message_set_;
-		}
-
-		const std::vector<can_signal_t>& get_can_signals()
-		{
-			return can_signals_[active_message_set_];
-		}
-
-		const std::vector<can_message_definition_t>& get_can_message_definition()
-		{
-			return can_message_definition_[active_message_set_];
-		}
-
-		const std::vector<obd2_signal_t>& get_obd2_signals()
-		{
-			return obd2_signals_;
-		}
-
-		uint32_t get_signal_id(obd2_signal_t& sig)
-		{
-			return sig.get_pid();
-		}
-
-		uint32_t get_signal_id(can_signal_t& sig)
-		{
-			return sig.get_message()->id;
-		}
-
-		void set_active_message_set(uint8_t id)
-		{
-			active_message_set_ = id;
-		}
+		configuration_t& get_configuration() const;
+
+		can_bus_t& get_can_bus_manager();
+
+		diagnostic_manager_t& get_diagnostic_manager() const;
+
+		uint8_t get_active_message_set() const;
+
+		const std::vector<can_message_set_t>& get_can_message_set() const;
+
+		const std::vector<can_signal_t>& get_can_signals() const;
+
+		const std::vector<can_message_definition_t>& get_can_message_definition() const;
 
+		const std::vector<obd2_signal_t>& get_obd2_signals() const;
+
+		uint32_t get_signal_id(obd2_signal_t& sig) const;
+
+		uint32_t get_signal_id(can_signal_t& sig) const;
+
+		void set_active_message_set(uint8_t id);
+
+/*
+		/// TODO: implement this function as method into can_bus class
+		/// @brief Pre initialize actions made before CAN bus initialization
+		/// @param[in] bus A CanBus struct defining the bus's metadata
+		/// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs.
+		/// @param[in] buses An array of all CAN buses.
+		/// @param[in] busCount The length of the buses array.
 		void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
+		/// TODO: implement this function as method into can_bus class
+		/// @brief Post-initialize actions made after CAN bus initialization
+		/// @param[in] bus A CanBus struct defining the bus's metadata
+		/// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs.
+		/// @param[in] buses An array of all CAN buses.
+		/// @param[in] busCount The length of the buses array.
 		void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
+		/// TODO: implement this function as method into can_bus class
+		/// @brief Check if the device is connected to an active CAN bus, i.e. it's received a message in the recent past.
+		/// @return true if a message was received on the CAN bus within CAN_ACTIVE_TIMEOUT_S seconds.
 		void logBusStatistics(can_bus_dev_t* buses, const int busCount);
+		/// TODO: implement this function as method into can_bus class
+		/// @brief Log transfer statistics about all active CAN buses to the debug log.
+		/// @param[in] buses An array of active CAN buses.
+		/// @param[in] busCount The length of the buses array.
 		bool isBusActive(can_bus_dev_t* bus);
-};
\ No newline at end of file
+		*/
+};
+
+// Make a global variable pointer
+extern configuration_t *config;
+