Added a warning that it is an example code

Change-Id: Ib66e49960a348896020fba56f7d98910623af83f
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>

2 files changed, 13 insertions, 13 deletions

diff --git a/src/diagnostic/diagnostic-message.cpp b/src/diagnostic/diagnostic-message.cpp
index 656a868..d99541b 100644
--- a/src/diagnostic/diagnostic-message.cpp
+++ b/src/diagnostic/diagnostic-message.cpp
@@ -32,12 +32,12 @@ const char *UNIT_NAMES[10] = {
 	"NM"
 };
 
-obd2_signals_t::obd2_signals_t(uint8_t pid, const char* generic_name, const int min, const int max, enum UNIT unit, int frequency, bool supported)
+obd2_signal_t::obd2_signal_t(uint8_t pid, const char* generic_name, const int min, const int max, enum UNIT unit, int frequency, bool supported)
 	:	pid_{pid}, generic_name_{generic_name}, min_{min}, max_{max}, unit_{unit}, frequency_{frequency}, supported_{supported}
 {
 }
 
-uint32_t obd2_signals_t::get_pid()
+uint32_t obd2_signal_t::get_pid()
 {
 	return (uint32_t)pid_;
 }
@@ -51,7 +51,7 @@ uint32_t obd2_signals_t::get_pid()
  *
  * @return std::vector<std::string> Vector of signals name found. 
  */
-void obd2_signals_t::find_obd2_signals(const openxc_DynamicField &key, std::vector<obd2_signals_t*>& found_signals)
+void obd2_signal_t::find_obd2_signals(const openxc_DynamicField &key, std::vector<obd2_signal_t*>& found_signals)
 {
 	switch(key.type)
 	{
@@ -68,7 +68,7 @@ void obd2_signals_t::find_obd2_signals(const openxc_DynamicField &key, std::vect
 	DEBUG(binder_interface, "Found %d signal(s)", (int)found_signals.size());
 }
 
-bool obd2_signals_t::is_obd2_response(can_message_t can_message)
+bool obd2_signal_t::is_obd2_response(can_message_t can_message)
 {
 	/*
 	if(can_message.get_id() >= 0x7E8 && can_message.get_id() <= 0x7EF)
@@ -111,7 +111,7 @@ bool obd2_signals_t::is_obd2_response(can_message_t can_message)
 	*/
 }
 
-void obd2_signals_t::add_request(int pid)
+void obd2_signal_t::add_request(int pid)
 {
 	DiagnosticRequest request = {
 	arbitration_id: OBD2_FUNCTIONAL_BROADCAST_ID,
@@ -123,7 +123,7 @@ void obd2_signals_t::add_request(int pid)
 *
 * @return true if the request is a mode 1 request and it has a 1 byte PID.
 */
-bool obd2_signals_t::is_obd2_request(DiagnosticRequest* request)
+bool obd2_signal_t::is_obd2_request(DiagnosticRequest* request)
 {
 	return request->mode == 0x1 && request->has_pid && request->pid < 0xff;
 }
@@ -133,7 +133,7 @@ bool obd2_signals_t::is_obd2_request(DiagnosticRequest* request)
 * 
 * @return true if name began with obd2 else false.
 */
-bool obd2_signals_t::is_obd2_signal(const char *name)
+bool obd2_signal_t::is_obd2_signal(const char *name)
 {
 	if(fnmatch("obd2.*", name, FNM_CASEFOLD) == 0)
 		return true;
@@ -153,7 +153,7 @@ bool obd2_signals_t::is_obd2_signal(const char *name)
 *  signiticant, i.e. with many OBD-II PID formulas.
 * @param[in] float parsed_payload - the entire payload of the response parsed as an int.
 */
-float obd2_signals_t::decode_obd2_response(const DiagnosticResponse* response, float parsedPayload)
+float obd2_signal_t::decode_obd2_response(const DiagnosticResponse* response, float parsedPayload)
 {
 	return diagnostic_decode_obd2_pid(response);
 }
\ No newline at end of file
diff --git a/src/diagnostic/diagnostic-message.hpp b/src/diagnostic/diagnostic-message.hpp
index ac6ca18..2d9cff6 100644
--- a/src/diagnostic/diagnostic-message.hpp
+++ b/src/diagnostic/diagnostic-message.hpp
@@ -65,7 +65,7 @@ typedef struct _Obd2Pid {
  * @brief - Object to handle obd2 session with pre-scan of supported pid
  * then request them regularly
  */
-class obd2_signals_t {
+class obd2_signal_t {
 	private:
 		uint8_t pid_; /*!< pid - The 1 byte PID.*/
 		const std::string generic_name_; /*!< generic_name_ - A human readable name to use for this PID when published.*/
@@ -77,13 +77,13 @@ class obd2_signals_t {
 
 	public:
 		const char* generic_name = generic_name_.c_str();
-		obd2_signals_t(uint8_t pid, const char* generic_name, const int min_, const int max_, enum UNIT unit, int frequency, bool supported);
+		obd2_signal_t(uint8_t pid, const char* generic_name, const int min_, const int max_, enum UNIT unit, int frequency, bool supported);
 
 		uint32_t get_pid();
 
 		void add_request(int pid);
 
-		void find_obd2_signals(const openxc_DynamicField &key, std::vector<obd2_signals_t*>& found_signals);
+		void find_obd2_signals(const openxc_DynamicField &key, std::vector<obd2_signal_t*>& found_signals);
 
 		bool is_obd2_response(can_message_t can_message);
 		bool is_obd2_request(DiagnosticRequest *request);
@@ -92,5 +92,5 @@ class obd2_signals_t {
 		float decode_obd2_response(const DiagnosticResponse* response, float parsedPayload);
 };
 
-uint32_t get_signal_id(obd2_signals_t& sig);
-std::vector<obd2_signals_t>& get_obd2_signals();
\ No newline at end of file
+uint32_t get_signal_id(obd2_signal_t& sig);
+std::vector<obd2_signal_t>& get_obd2_signals();
\ No newline at end of file