Simpler handling of binding subscriptions
[apps/agl-service-can-low-level.git] / low-can-binding / binding / application.hpp
index e272806..e017685 100644 (file)
 #include "../can/can-signals.hpp"
 #include "../diagnostic/diagnostic-manager.hpp"
 
-#include "low-can-hat.hpp"
-
 ///
-/// @brief Class representing a configuration attached to the binding.
+/// @brief Class represents 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
+/// It regroups all object instances from other classes
+///  that will be used through the binding life. It receives a global vision
 ///  on which signals are implemented for that binding.
-///  Here, it is only the definition of the class with predefined accessors
+///  Here, only the definition of the class is given with predefined accessors
 ///  methods used in the binding.
 ///
 ///  It will be the reference point to needed objects.
 class application_t
 {
        private:
-               can_bus_t can_bus_manager_; ///< instanciate the CAN bus manager. It's the one in charge of initialize the CAN bus devices.
+               can_bus_t can_bus_manager_; ///< instanciate the CAN bus manager. It's responsible of initializing the CAN bus devices.
                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<std::shared_ptr<can_message_set_t> > can_message_set_; ///< Vector holding all message set from JSON signals description file
 
-               std::map<std::string, std::shared_ptr<low_can_socket_t> > can_devices_; ///< Map containing all independant opened CAN sockets, key is the socket int value.
+               std::map<std::string, std::shared_ptr<low_can_subscription_t> > can_devices_; ///< Map containing all independant opened CAN sockets, key is the socket int value.
 
                application_t(); ///< Private constructor with implementation generated by the AGL generator.
 
@@ -58,7 +56,7 @@ class application_t
 
                can_bus_t& get_can_bus_manager();
 
-               std::map<std::string, std::shared_ptr<low_can_socket_t> >& get_can_devices();
+               std::map<std::string, std::shared_ptr<low_can_subscription_t> >& get_can_devices();
 
                const std::string get_diagnostic_bus() const;
 
@@ -80,6 +78,8 @@ class application_t
 
                uint32_t get_signal_id(can_signal_t& sig) const;
 
+               bool isEngineOn();
+
                void set_active_message_set(uint8_t id);
 
 /*
@@ -98,10 +98,6 @@ class application_t
                /// 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.
                bool isBusActive(can_bus_dev_t* bus);
                */
 };