summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-03-06 18:45:35 +0100
committerRomain Forlot <romain.forlot@iot.bzh>2017-03-06 18:47:40 +0100
commitd6c1b80cdbd87df96f3f648d67ccdbba6794f957 (patch)
treefe0b34aeeba161f48bf18903f7be080e418ab7b0
parentd7a294023e442d1e02f1b320326bf759ad49395c (diff)
Sort and comment the code
Change-Id: I1860c0d5fb03ce2217d5553159a090298596d939 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
-rw-r--r--src/can-signals.cpp44
-rw-r--r--src/can-signals.hpp19
-rw-r--r--src/signals.cpp45
-rw-r--r--src/signals.hpp16
4 files changed, 77 insertions, 47 deletions
diff --git a/src/can-signals.cpp b/src/can-signals.cpp
index bf6b4a4b..07689a01 100644
--- a/src/can-signals.cpp
+++ b/src/can-signals.cpp
@@ -42,56 +42,46 @@ std::vector<std::vector<CanSignal>> SIGNALS = {
},
};
-/**
- * @brief Can signal event map making access to afb_event
- * externaly to an openxc existing structure.
+/**
+ * @fn std::vector<CanSignal>& get_can_signals()
*
- * @desc Event map is making relation between CanSignal generic name
- * and the afb_event struct used by application framework to pushed
- * to the subscriber.
+ * @return A reference to a vector of signals
*/
-std::map<std::string, struct afb_event> subscribed_signals;
-
-/**
-* @brief Mutex allowing safe manipulation on subscribed_signals map.
-* @desc To ensure that the map object isn't modified when we read it, you
-* have to set this mutex before use subscribed_signals map object.
-*/
-std::mutex subscribed_signals_mutex;
-
-std::mutex& get_subscribed_signals_mutex()
-{
- return subscribed_signals_mutex;
-}
-
-std::map<std::string, struct afb_event>& get_subscribed_signals()
-{
- return subscribed_signals;
-}
-
std::vector<CanSignal>& get_can_signals()
{
return SIGNALS[MESSAGE_SET_ID];
}
+/**
+ * @fn size_t getSignalCount()
+ *
+ * @return the length of the array returned by get_can_signals().
+ */
size_t getSignalCount()
{
return SIGNALS[MESSAGE_SET_ID].size();
}
+/**
+ * @brief Retrieve can arbitration id of a given CanSignal
+ *
+ * @param[in] CanSignal& - a const reference to a CanSignal
+ *
+ * @return uint32_t - unsigned integer representing the arbitration id.
+ */
uint32_t get_signal_id(const CanSignal& sig)
{
return sig.message->id;
}
/**
- * @fn std::vector<std::string> find_signals(const openxc_DynamicField &key)
+ * @fn void find_can_signals(const openxc_DynamicField& key, std::vector<CanSignal*>& found_signals)
* @brief return signals name found searching through CAN_signals and OBD2 pid
*
* @param[in] const openxc_DynamicField : can contain numeric or string value in order to search against
* can signals or obd2 signals name.
+ * @param[out] std::vector<CanSignal*>& found_signals : provided vector to fill with ponter to signals matched.
*
- * @return std::vector<std::string> Vector of signals name found.
*/
void find_can_signals(const openxc_DynamicField& key, std::vector<CanSignal*>& found_signals)
{
diff --git a/src/can-signals.hpp b/src/can-signals.hpp
index 547769f4..250ff197 100644
--- a/src/can-signals.hpp
+++ b/src/can-signals.hpp
@@ -133,29 +133,10 @@ struct CanSignal {
};
typedef struct CanSignal CanSignal;
-/* Public: Return signals from an signals array filtered on name.
- */
std::vector<CanSignal>& get_can_signals();
-/* Public: Return the length of the array returned by get_can_signals(). */
size_t getSignalCount();
-/**
- * @brief Find one or many signals based on its name or id
- * passed through openxc_DynamicField.
- *
- * @param[in] openxc_DynamicField& - a const reference with the key to search into signal.
- * Key is either a signal name or its CAN arbitration id.
- *
- * @return std::vector<std::string> return found CanSignal generic name vector.
- */
void find_can_signals(const openxc_DynamicField &key, std::vector<CanSignal*>& found_signals);
-/**
- * @brief Retrieve can arbitration id of a given CanSignal
- *
- * @param[in] CanSignal& - a const reference to a CanSignal
- *
- * @return uint32_t - unsigned integer representing the arbitration id.
- */
uint32_t get_signal_id(const CanSignal& sig); \ No newline at end of file
diff --git a/src/signals.cpp b/src/signals.cpp
index d163c6f0..6e2f396a 100644
--- a/src/signals.cpp
+++ b/src/signals.cpp
@@ -1,10 +1,53 @@
+/*
+ * Copyright (C) 2015, 2016 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
#include "signals.hpp"
+/**
+ * @brief Can signal event map making access to afb_event
+ * externaly to an openxc existing structure.
+ *
+ * @desc Event map is making relation between CanSignal generic name
+ * and the afb_event struct used by application framework to pushed
+ * to the subscriber.
+ */
+std::map<std::string, struct afb_event> subscribed_signals;
+
+/**
+* @brief Mutex allowing safe manipulation on subscribed_signals map.
+* @desc To ensure that the map object isn't modified when we read it, you
+* have to set this mutex before use subscribed_signals map object.
+*/
+std::mutex subscribed_signals_mutex;
+
+std::mutex& get_subscribed_signals_mutex()
+{
+ return subscribed_signals_mutex;
+}
+
+std::map<std::string, struct afb_event>& get_subscribed_signals()
+{
+ return subscribed_signals;
+}
+
/**
* @fn std::vector<std::string> find_signals(const openxc_DynamicField &key)
* @brief return signals name found searching through CAN_signals and OBD2 pid
- *
+ *
* @param[in] const openxc_DynamicField : can contain numeric or string value in order to search against
* can signals or obd2 signals name.
*
diff --git a/src/signals.hpp b/src/signals.hpp
index 53d19d51..81ed4248 100644
--- a/src/signals.hpp
+++ b/src/signals.hpp
@@ -1,3 +1,19 @@
+/*
+ * Copyright (C) 2015, 2016 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
#pragma once