summaryrefslogtreecommitdiffstats
path: root/low-can-binding/binding/low-can-socket.hpp
diff options
context:
space:
mode:
authorJan-Simon Moeller <jsmoeller@linuxfoundation.org>2018-05-25 18:53:52 +0000
committerGerrit Code Review <gerrit@automotivelinux.org>2018-05-25 18:53:52 +0000
commit88befdfd812a58fb7a36e090278ad1e70003e925 (patch)
treedd04c9b6d8d6e534e0c2687250b18a006964bd18 /low-can-binding/binding/low-can-socket.hpp
parent438bf4912a1174c63fac77fe72e3b320c589f431 (diff)
parent2eb313e5330dbfa1b6eab146b3698d8ffe054347 (diff)
Merge "Fixing typos made in comments"flounder_5.99.1flounder/5.99.15.99.1
Diffstat (limited to 'low-can-binding/binding/low-can-socket.hpp')
-rw-r--r--low-can-binding/binding/low-can-socket.hpp16
1 files changed, 8 insertions, 8 deletions
diff --git a/low-can-binding/binding/low-can-socket.hpp b/low-can-binding/binding/low-can-socket.hpp
index 71731b30..dee7bd13 100644
--- a/low-can-binding/binding/low-can-socket.hpp
+++ b/low-can-binding/binding/low-can-socket.hpp
@@ -25,21 +25,21 @@
#include "../diagnostic/diagnostic-message.hpp"
#include "../utils/socketcan-bcm.hpp"
-/// @brief Filtering values. Theses values has to be tested into
+/// @brief Filtering values. Theses values have to be tested in
/// can_bus_t::apply_filter method.
struct event_filter_t
{
- float frequency; ///< frequency - Maximum frequency which will be received and pushed a subscribed event.
- float min; ///< min - Minimum value that the signal don't have to go below to be pushed.
- float max; ///< max - Maximum value that the signal don't have to go above to be pushed.
+ float frequency; ///< frequency - Maximum frequency which will be received and pushed to a subscribed event.
+ float min; ///< min - Minimum value that the signal doesn't have to go below to be pushed.
+ float max; ///< max - Maximum value that the signal doesn't have to go above to be pushed.
event_filter_t() : frequency{0}, min{-__FLT_MAX__}, max{__FLT_MAX__} {};
bool operator==(const event_filter_t& ext) const {
return frequency == ext.frequency && min == ext.min && max == ext.max;
}
};
-/// @brief An object storing socket to CAN to be used to write on it.
-/// This is a simple access to a CAN bus device without subscriptions attached
+/// @brief The object stores socket to CAN to be used to write on it.
+/// This is a simple access to a CAN bus device without any subscriptions attached
class low_can_socket_t
{
protected:
@@ -48,8 +48,8 @@ protected:
/// Signal part
std::shared_ptr<can_signal_t> can_signal_; ///< can_signal_ - the CAN signal subscribed
- std::vector<std::shared_ptr<diagnostic_message_t> > diagnostic_message_; ///< diagnostic_message_ - diagnostic messages meant to received OBD2 responses.
- /// normal diagnostic request and response not tested for now.
+ std::vector<std::shared_ptr<diagnostic_message_t> > diagnostic_message_; ///< diagnostic_message_ - diagnostic messages meant to receive OBD2 responses.
+ /// normal diagnostic request and response are not tested for now.
utils::socketcan_bcm_t socket_; ///< socket_ - socket_ that receives CAN messages.