can_callbacks.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
 
#ifndef CAN_CALLBACKS_HPP
#define CAN_CALLBACKS_HPP
 
#include <functional>
#include "isobus/isobus/can_message.hpp"
 
namespace isobus
{
    // Forward declare some classes
    class InternalControlFunction;
    class ControlFunction;
 
    enum class AcknowledgementType : std::uint8_t
    {
        Positive = 0, 
        Negative = 1, 
        AccessDenied = 2, 
        CannotRespond = 3 
    };
 
    enum class ControlFunctionState
    {
        Offline, 
        Online 
    };
 
    using CANLibCallback = void (*)(const CANMessage &message, void *parentPointer);
    using CANMessageCallback = std::function<void(const CANMessage &message)>;
    using CANMessageFrameCallback = std::function<bool(std::uint32_t parameterGroupNumber,
                                                       CANDataSpan data,
                                                       std::shared_ptr<InternalControlFunction> sourceControlFunction,
                                                       std::shared_ptr<ControlFunction> destinationControlFunction,
                                                       CANIdentifier::CANPriority priority)>; 
    using ControlFunctionStateCallback = void (*)(std::shared_ptr<ControlFunction> controlFunction, ControlFunctionState state);
    using DataChunkCallback = bool (*)(std::uint32_t callbackIndex,
                                       std::uint32_t bytesOffset,
                                       std::uint32_t numberOfBytesNeeded,
                                       std::uint8_t *chunkBuffer,
                                       void *parentPointer);
    using TransmitCompleteCallback = void (*)(std::uint32_t parameterGroupNumber,
                                              std::uint32_t dataLength,
                                              std::shared_ptr<InternalControlFunction> sourceControlFunction,
                                              std::shared_ptr<ControlFunction> destinationControlFunction,
                                              bool successful,
                                              void *parentPointer);
    using PGNRequestCallback = bool (*)(std::uint32_t parameterGroupNumber,
                                        std::shared_ptr<ControlFunction> requestingControlFunction,
                                        bool &acknowledge,
                                        AcknowledgementType &acknowledgeType,
                                        void *parentPointer);
    using PGNRequestForRepetitionRateCallback = bool (*)(std::uint32_t parameterGroupNumber,
                                                         std::shared_ptr<ControlFunction> requestingControlFunction,
                                                         std::shared_ptr<ControlFunction> targetControlFunction,
                                                         std::uint32_t repetitionRate,
                                                         void *parentPointer);
 
    class ParameterGroupNumberCallbackData
    {
    public:
        ParameterGroupNumberCallbackData(std::uint32_t parameterGroupNumber, CANLibCallback callback, void *parentPointer, std::shared_ptr<InternalControlFunction> internalControlFunction);
 
        bool operator==(const ParameterGroupNumberCallbackData &obj) const;
 
        std::uint32_t get_parameter_group_number() const;
 
        CANLibCallback get_callback() const;
 
        void *get_parent() const;
 
        std::shared_ptr<InternalControlFunction> get_internal_control_function() const;
 
    private:
        CANLibCallback callback; 
        std::uint32_t parameterGroupNumber; 
        void *parent; 
        std::shared_ptr<InternalControlFunction> internalControlFunctionFilter; 
    };
} // namespace isobus
 
#endif // CAN_CALLBACKS_HPP