can_partnered_control_function.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
 
#ifndef CAN_PARTNERED_CONTROL_FUNCTION_HPP
#define CAN_PARTNERED_CONTROL_FUNCTION_HPP
 
#include "isobus/isobus/can_NAME_filter.hpp"
#include "isobus/isobus/can_address_claim_state_machine.hpp"
#include "isobus/isobus/can_badge.hpp"
#include "isobus/isobus/can_callbacks.hpp"
#include "isobus/isobus/can_control_function.hpp"
 
#include <vector>
 
namespace isobus
{
    class CANNetworkManager;
    class InternalControlFunction;
 
    //================================================================================================
    //================================================================================================
    class PartneredControlFunction : public ControlFunction
    {
    public:
        static std::shared_ptr<PartneredControlFunction> create(std::uint8_t CANPort, const std::vector<NAMEFilter> NAMEFilters);
 
        PartneredControlFunction(std::uint8_t CANPort, const std::vector<NAMEFilter> NAMEFilters, CANLibBadge<PartneredControlFunction>);
 
        PartneredControlFunction(PartneredControlFunction &) = delete;
 
        void add_parameter_group_number_callback(std::uint32_t parameterGroupNumber, CANLibCallback callback, void *parent, std::shared_ptr<InternalControlFunction> internalControlFunction = nullptr);
 
        void remove_parameter_group_number_callback(std::uint32_t parameterGroupNumber, CANLibCallback callback, void *parent, std::shared_ptr<InternalControlFunction> internalControlFunction = nullptr);
 
        std::size_t get_number_parameter_group_number_callbacks() const;
 
        std::size_t get_number_name_filters() const;
 
        std::size_t get_number_name_filters_with_parameter_type(NAME::NAMEParameters parameter);
 
        bool get_name_filter_parameter(std::size_t index, NAME::NAMEParameters &parameter, std::uint32_t &filterValue) const;
 
        bool check_matches_name(NAME NAMEToCheck) const;
 
    private:
        friend class CANNetworkManager; 
 
        static std::shared_ptr<ControlFunction> create(NAME, std::uint8_t, std::uint8_t) = delete;
 
        ParameterGroupNumberCallbackData &get_parameter_group_number_callback(std::size_t index);
 
        const std::vector<NAMEFilter> NAMEFilterList; 
        std::vector<ParameterGroupNumberCallbackData> parameterGroupNumberCallbacks; 
        bool initialized = false; 
    };
 
} // namespace isobus
 
#endif // CAN_PARTNERED_CONTROL_FUNCTION