Make error goes back to the subscribed clients when unsupported.
[apps/agl-service-can-low-level.git] / src / configuration.hpp
index fb7b840..57eeef3 100644 (file)
@@ -17,7 +17,9 @@
 
 #pragma once
 
+#include <map>
 #include <vector>
+#include <string>
 #include <fcntl.h>
 
 #include "can/can-bus.hpp"
 
 #include "low-can-binding.hpp"
 
-/**
- * @brief Class representing a configuration attached to the binding.
- *
- * @desc It regroups all needed objects instance from other class
- *  that will be used along the binding life. It gets a global vision 
- *  on which signals are implemented for that binding. 
- *  Here, it is only the definition of the class with predefined accessors
- *  methods used in the binding.
- *
- *  It will be the reference point to needed objects.
- */
+///
+/// @brief Class representing a configuration attached to the binding.
+///
+/// It regroups all needed objects instance from other class
+///  that will be used along the binding life. It gets a global vision 
+///  on which signals are implemented for that binding. 
+///  Here, it is only the definition of the class with predefined accessors
+///  methods used in the binding.
+///
+///  It will be the reference point to needed objects.
+///
 class configuration_t
 {
        private:
-               can_bus_t can_bus_manager_ = can_bus_t(afb_daemon_rootdir_open_locale(binder_interface->daemon, "etc/can_buses.json", O_RDONLY, NULL));
-               diagnostic_manager_t diagnostic_manager_;
-               uint8_t active_message_set_ = 0;
-               std::vector<std::string> signals_prefix_;
+               can_bus_t can_bus_manager_ = can_bus_t(
+                       afb_daemon_rootdir_open_locale(
+                               binder_interface->daemon, "etc/can_buses.json", O_RDONLY, NULL)); ///< instanciate the CAN bus
+                               ///< This will read the configuration file and initialize all CAN devices specified in it.
+               diagnostic_manager_t diagnostic_manager_; ///< Diagnostic manager use to manage diagnostic message communication.
+               uint8_t active_message_set_ = 0; ///< Which is the active message set ? Default to 0.
 
                std::vector<can_message_set_t> can_message_set_;
                std::vector<std::vector<can_message_definition_t>> can_message_definition_;
                std::vector<std::vector<can_signal_t>> can_signals_;
                std::vector<std::vector<diagnostic_message_t>> diagnostic_messages_;
 
-               /// Private constructor with implementation generated by the AGL generator.
-               configuration_t();
+               configuration_t(); ///< Private constructor with implementation generated by the AGL generator.
 
        public:
                static configuration_t& instance();
 
-               configuration_t& get_configuration() ;
-
                can_bus_t& get_can_bus_manager();
 
                const std::map<std::string, std::shared_ptr<can_bus_dev_t>>& get_can_bus_devices();
@@ -114,5 +115,3 @@ class configuration_t
                */
 };
 
-// TEMP Function to access OBD2_PIDS vector
-std::vector<diagnostic_message_t> get_predefined_obd2();