isobus_shortcut_button_interface.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
#ifndef ISOBUS_SHORTCUT_BUTTON_INTERFACE_HPP
#define ISOBUS_SHORTCUT_BUTTON_INTERFACE_HPP
 
#include "isobus/isobus/can_NAME.hpp"
#include "isobus/isobus/can_internal_control_function.hpp"
#include "isobus/isobus/can_message.hpp"
#include "isobus/utility/event_dispatcher.hpp"
#include "isobus/utility/processing_flags.hpp"
 
#include <array>
#include <functional>
#include <list>
#include <memory>
 
namespace isobus
{
    class ShortcutButtonInterface
    {
    public:
        enum class StopAllImplementOperationsState : std::uint8_t
        {
            StopImplementOperations = 0, 
            PermitAllImplementsToOperationOn = 1, 
            Error = 2, 
            NotAvailable = 3 
        };
 
        ShortcutButtonInterface(std::shared_ptr<InternalControlFunction> internalControlFunction, bool serverEnabled = false);
 
        virtual ~ShortcutButtonInterface();
 
        void initialize();
 
        bool get_is_initialized() const;
 
        EventDispatcher<StopAllImplementOperationsState> &get_stop_all_implement_operations_state_event_dispatcher();
 
        void set_stop_all_implement_operations_state(StopAllImplementOperationsState newState);
 
        StopAllImplementOperationsState get_state() const;
 
        void update();
 
    private:
        class ISBServerData
        {
        public:
            ISBServerData() = default;
 
            NAME ISONAME; 
            StopAllImplementOperationsState commandedState; 
            std::uint32_t messageReceivedTimestamp_ms = 0; 
            std::uint8_t stopAllImplementOperationsTransitionNumber = 0; 
        };
 
        enum class TransmitFlags : std::uint32_t
        {
            SendStopAllImplementOperationsSwitchState = 0, 
 
            NumberOfFlags 
        };
 
        static void process_rx_message(const CANMessage &message, void *parentPointer);
 
        static void process_flags(std::uint32_t flag, void *parent);
 
        void process_message(const CANMessage &message);
 
        bool send_stop_all_implement_operations_switch_state() const;
 
        static constexpr std::uint32_t TRANSMISSION_RATE_MS = 1000; 
        static constexpr std::uint32_t TRANSMISSION_TIMEOUT_MS = 3000; 
 
        std::list<ISBServerData> isobusShorcutButtonList; 
        std::shared_ptr<InternalControlFunction> sourceControlFunction = nullptr; 
        EventDispatcher<StopAllImplementOperationsState> ISBEventDispatcher; 
        ProcessingFlags txFlags; 
        std::uint32_t allImplementsStopOperationsSwitchStateTimestamp_ms = 0; 
        std::uint8_t stopAllImplementOperationsTransitionNumber = 0; 
        StopAllImplementOperationsState commandedState = StopAllImplementOperationsState::NotAvailable; 
        bool actAsISBServer = false; 
        bool initialized = false; 
    };
} // namespace isobus
#endif // ISOBUS_SHORTCUT_BUTTON_INTERFACE_HPP