Rename some of the classes removing can- prefix

[apps/agl-service-can-low-level.git] / low-can-binding / binding / application.hpp

diff --git a/low-can-binding/binding/application.hpp b/low-can-binding/binding/application.hpp
index fa2204f..f56900a 100644 (file)
--- a/low-can-binding/binding/application.hpp
+++ b/low-can-binding/binding/application.hpp
@@ -23,17 +23,17 @@
 #include <memory>
 
 #include "../can/can-bus.hpp"
-#include "../can/can-message-set.hpp"
-#include "../can/can-signals.hpp"
+#include "../can/message-set.hpp"
+#include "../can/signals.hpp"
 #include "../diagnostic/diagnostic-manager.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.
@@ -41,13 +41,13 @@
 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::vector<std::shared_ptr<message_set_t> > 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.
 
@@ -56,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;
 
@@ -64,19 +64,21 @@ class application_t
 
                uint8_t get_active_message_set() const;
 
-               std::vector<std::shared_ptr<can_message_set_t> > get_can_message_set();
+               std::vector<std::shared_ptr<message_set_t> > get_message_set();
 
-               std::vector<std::shared_ptr<can_signal_t> > get_all_can_signals();
+               std::vector<std::shared_ptr<signal_t> > get_all_signals();
 
-               std::vector<std::shared_ptr<diagnostic_message_t> >& get_diagnostic_messages();
+               std::vector<std::shared_ptr<diagnostic_message_t> > get_diagnostic_messages();
 
                const std::vector<std::string>& get_signals_prefix() const;
 
-               std::vector<std::shared_ptr<can_message_definition_t> >& get_can_message_definition();
+               std::vector<std::shared_ptr<message_definition_t> > get_messages_definition();
 
                uint32_t get_signal_id(diagnostic_message_t& sig) const;
 
-               uint32_t get_signal_id(can_signal_t& sig) const;
+               uint32_t get_signal_id(signal_t& sig) const;
+
+               bool isEngineOn();
 
                void set_active_message_set(uint8_t id);