X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fcan-signals.hpp;h=374afeeae556a881c8f4f440471d53ea145d1dc5;hb=b0975e4bfa534153657a7ee8acaee0f950056e97;hp=2720513741364c585596559e4513fb70d5ad0a9c;hpb=15250b2e51e8383a0df4b6e5a870c07e914d406d;p=apps%2Fagl-service-can-low-level.git diff --git a/src/can-signals.hpp b/src/can-signals.hpp index 27205137..374afeea 100644 --- a/src/can-signals.hpp +++ b/src/can-signals.hpp @@ -17,41 +17,63 @@ #pragma once -#include "can-utils.hpp" +#include +#include #include +#include +#include + +#include "can-utils.hpp" + +extern "C" +{ + #include +} + +#define MESSAGE_SET_ID 0 + +/** + * @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. + */ +static std::map subscribed_signals; /** Public: Return the currently active CAN configuration. */ CanMessageSet* getActiveMessageSet(); /** Public: Retrive a list of all possible CAN configurations. - * * - * * Returns a pointer to an array of all configurations. - * */ + * + * Returns a pointer to an array of all configurations. + */ CanMessageSet* getMessageSets(); /** Public: Return the length of the array returned by getMessageSets() */ int getMessageSetCount(); /* Public: Return the number of CAN buses configured in the active - * * configuration. This is limited to 2, as the hardware controller only has 2 - * * CAN channels. - * */ + * configuration. This is limited to 2, as the hardware controller only has 2 + * CAN channels. + */ int getCanBusCount(); /* Public: Return an array of all CAN messages to be processed in the active - * * configuration. - * */ + * configuration. + */ CanMessageDefinition* getMessages(); /* Public: Return signals from an signals array filtered on name. */ -CanSignal* getSignals(std::string name); +const std::vector getSignals(); /* Public: Return an array of all OpenXC CAN commands enabled in the active - * * configuration that can write back to CAN with a custom handler. - * * - * * Commands not defined here are handled using a 1-1 mapping from the signals - * * list. + * configuration that can write back to CAN with a custom handler. + * + * * Commands not defined here are handled using a 1-1 mapping from the signals + * list. * */ CanCommand* getCommands(); @@ -59,24 +81,40 @@ CanCommand* getCommands(); int getCommandCount(); /* Public: Return the length of the array returned by getSignals(). */ -int getSignalCount(); +size_t getSignalCount(); /* Public: Return the length of the array returned by getMessages(). */ int getMessageCount(); -/* Public: Return an array of the metadata for the 2 CAN buses you want to - * * monitor. The size of this array is fixed at 2. - * */ +/** + * @brief Return an array of the metadata for the 2 CAN buses you want to + * monitor. The size of this array is fixed at 2. + */ CanBus* getCanBuses(); - /** * @brief Find one or many signals based on its name or id * passed through openxc_DynamicField. * - * params[openxc_DynamicField&] - a const reference with the key to search into signal. + * @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] return found CanSignal array. + * @return std::vector return found CanSignal generic name vector. + */ +std::vector find_can_signals(const struct afb_binding_interface* interface, const openxc_DynamicField &key); + +/** + * @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. + */ +inline uint32_t get_CanSignal_id(const CanSignal& sig); + +/** + * @brief return the subscribed_signals map. + * + * return std::map - map of subscribed signals. */ -std::vector find_can_signals(const openxc_DynamicField &key) \ No newline at end of file +const std::map get_subscribed_signals(); \ No newline at end of file