Keep subscription to signal simplier without doubling
[apps/agl-service-can-low-level.git] / src / can / can-signals.hpp
index e5e0f31..c1d07ee 100644 (file)
 #include <string>
 
 #include "openxc.pb.h"
-#include "utils/timer.hpp"
-#include "can/can-bus.hpp"
-#include "can/can-message.hpp"
-#include "obd2/obd2-signals.hpp"
+#include "../utils/timer.hpp"
+#include "can-bus.hpp"
+#include "can-message.hpp"
+#include "../obd2/obd2-signals.hpp"
 
 extern "C"
 {
@@ -76,18 +76,20 @@ class can_signal_t
 {
 private:
        can_message_definition_t message_; /*!< message_ - The message this signal is a part of. */
-       std::string generic_name_; /*!< generic_name_ - The name of the signal to be output over USB.*/
-       uint8_t bitPosition_; /*!< bitPosition_ - The starting bit of the signal in its CAN message (assuming
+       std::string generic_name_; /*!< generic_name_ - The name of the signal to be output.*/
+       std::string prefix_ = "messages."; /*!< prefix_ - generic_name_ will be prefixed with it. It has to reflect the used protocol.
+                                                 * which make easier to sort message when the come in.*/
+       uint8_t bit_position_; /*!< bitPosition_ - The starting bit of the signal in its CAN message (assuming
                                                                                *       non-inverted bit numbering, i.e. the most significant bit of
                                                                                *       each byte is 0) */
-       uint8_t bitSize_; /*!< bitSize_ - The width of the bit field in the CAN message. */
+       uint8_t bit_size_; /*!< bitSize_ - The width of the bit field in the CAN message. */
        float factor_; /*!< factor_ - The final value will be multiplied by this factor. Use 1 if you
                                                        *       don't need a factor. */
        float offset_; /*!< offset_ - The final value will be added to this offset. Use 0 if you
                                                        *       don't need an offset. */
        float min_value_; /*!< min_value_ - The minimum value for the processed signal.*/
        float max_value_; /*!< max_value_ - The maximum value for the processed signal. */
-       FrequencyClock frequency_; /*!< frequency_ - A FrequencyClock struct to control the maximum frequency to
+       frequency_clock_t frequency_; /*!< frequency_ - A frequency_clock_t struct to control the maximum frequency to
                                                                *       process and send this signal. To process every value, set the
                                                                *       clock's frequency to 0. */
        bool send_same_; /*!< send_same_ - If true, will re-send even if the value hasn't changed.*/
@@ -95,7 +97,6 @@ private:
                                                                *       value if it has changed. */
        std::map<int, std::string> states_; /*!< states_ - A map of CAN signal state describing the mapping
                                                                                                                                        * between numerical and string values for valid states. */
-       uint8_t state_count_; /*!< state_count_ - The length of the states array. */
        bool writable_; /*!< writable - True if the signal is allowed to be written from the USB host
                                        *       back to CAN. Defaults to false.*/
        SignalDecoder decoder_; /*!< decoder_ - An optional function to decode a signal from the bus to a human
@@ -104,12 +105,32 @@ private:
                                                         * CAN into a byte array. If NULL, the default numerical encoder
                                                         * is used. */
        bool received_; /*!< received_ - True if this signal has ever been received.*/
-       float lastValue_; /*!< lastValue_ - The last received value of the signal. If 'received' is false,
+       float last_value_; /*!< lastValue_ - The last received value of the signal. If 'received' is false,
                                           *    this value is undefined. */
 
 public:
-       can_message_definition_t& get_message() const;
-       std::string& get_generic_name() const;
-};
+       can_message_definition_t& get_message();
+       const std::string& get_generic_name() const;
+       const std::string get_name() const;
+       const std::string& get_prefix() const;
+       uint8_t get_bit_position() const;
+       uint8_t get_bit_size() const;
+       float get_factor() const;
+       float get_offset() const;
+       float get_min_value() const;
+       float get_max_value() const;
+       frequency_clock_t& get_frequency();
+       bool get_send_same() const;
+       bool get_force_send_changed() const;
+       std::map<int, std::string> get_state() const;
+       size_t get_state_count() const;
+       bool get_writable() const;
+       SignalDecoder& get_decoder();
+       SignalEncoder& get_encoder();
+       bool get_received() const;
+       float get_last_value() const;
 
-void find_can_signals(const openxc_DynamicField &key, std::vector<can_signal_t*>& found_signals);
+       void set_prefix(std::string val);
+       void set_received(bool r);
+       void set_last_value(float val);
+};
\ No newline at end of file