can_parameter_group_number_request_protocol.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
#ifndef CAN_PARAMETER_GROUP_NUMBER_REQUEST_PROTOCOL_HPP
#define CAN_PARAMETER_GROUP_NUMBER_REQUEST_PROTOCOL_HPP
 
#include "isobus/isobus/can_badge.hpp"
#include "isobus/isobus/can_control_function.hpp"
#include "isobus/isobus/can_network_manager.hpp"
 
#include <memory>
 
namespace isobus
{
    //================================================================================================
    //================================================================================================
    class ParameterGroupNumberRequestProtocol
    {
    public:
        ParameterGroupNumberRequestProtocol(std::shared_ptr<InternalControlFunction> internalControlFunction, CANLibBadge<InternalControlFunction>);
 
        ~ParameterGroupNumberRequestProtocol();
 
        ParameterGroupNumberRequestProtocol(const ParameterGroupNumberRequestProtocol &) = delete;
 
        ParameterGroupNumberRequestProtocol &operator=(const ParameterGroupNumberRequestProtocol &) = delete;
 
        static bool request_parameter_group_number(std::uint32_t pgn, std::shared_ptr<InternalControlFunction> source, std::shared_ptr<ControlFunction> destination);
 
        static bool request_repetition_rate(std::uint32_t pgn, std::uint16_t repetitionRate_ms, std::shared_ptr<InternalControlFunction> source, std::shared_ptr<ControlFunction> destination);
 
        bool register_pgn_request_callback(std::uint32_t pgn, PGNRequestCallback callback, void *parentPointer);
 
        bool register_request_for_repetition_rate_callback(std::uint32_t pgn, PGNRequestForRepetitionRateCallback callback, void *parentPointer);
 
        bool remove_pgn_request_callback(std::uint32_t pgn, PGNRequestCallback callback, void *parentPointer);
 
        bool remove_request_for_repetition_rate_callback(std::uint32_t pgn, PGNRequestForRepetitionRateCallback callback, void *parentPointer);
 
        std::size_t get_number_registered_pgn_request_callbacks() const;
 
        std::size_t get_number_registered_request_for_repetition_rate_callbacks() const;
 
    private:
        class PGNRequestCallbackInfo
        {
        public:
            PGNRequestCallbackInfo(PGNRequestCallback callback, std::uint32_t parameterGroupNumber, void *parentPointer);
 
            bool operator==(const PGNRequestCallbackInfo &obj) const;
 
            PGNRequestCallback callbackFunction; 
            std::uint32_t pgn; 
            void *parent; 
        };
 
        class PGNRequestForRepetitionRateCallbackInfo
        {
        public:
            PGNRequestForRepetitionRateCallbackInfo(PGNRequestForRepetitionRateCallback callback, std::uint32_t parameterGroupNumber, void *parentPointer);
 
            bool operator==(const PGNRequestForRepetitionRateCallbackInfo &obj) const;
 
            PGNRequestForRepetitionRateCallback callbackFunction; 
            std::uint32_t pgn; 
            void *parent; 
        };
 
        static constexpr std::uint8_t PGN_REQUEST_LENGTH = 3; 
 
        void process_message(const CANMessage &message);
 
        static void process_message(const CANMessage &message, void *parent);
 
        bool send_acknowledgement(AcknowledgementType type, std::uint32_t parameterGroupNumber, std::shared_ptr<ControlFunction> destination) const;
 
        std::shared_ptr<InternalControlFunction> myControlFunction; 
        std::vector<PGNRequestCallbackInfo> pgnRequestCallbacks; 
        std::vector<PGNRequestForRepetitionRateCallbackInfo> repetitionRateCallbacks; 
        Mutex pgnRequestMutex; 
    };
}
 
#endif // CAN_PARAMETER_GROUP_NUMBER_REQUEST_PROTOCOL_HPP