isobus_virtual_terminal_client_state_tracker.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
 
#ifndef ISOBUS_VIRTUAL_TERMINAL_CLIENT_STATE_TRACKER_HPP
#define ISOBUS_VIRTUAL_TERMINAL_CLIENT_STATE_TRACKER_HPP
 
#include "isobus/isobus/can_constants.hpp"
#include "isobus/isobus/can_control_function.hpp"
#include "isobus/isobus/can_message.hpp"
 
#include <deque>
#include <map>
#include <vector>
 
namespace isobus
{
    class VirtualTerminalClientStateTracker
    {
    public:
        explicit VirtualTerminalClientStateTracker(std::shared_ptr<ControlFunction> client);
 
        ~VirtualTerminalClientStateTracker();
 
        void initialize();
 
        void terminate();
 
 
        void add_tracked_numeric_value(std::uint16_t objectId, std::uint32_t initialValue = 0);
 
        void remove_tracked_numeric_value(std::uint16_t objectId);
 
        std::uint32_t get_numeric_value(std::uint16_t objectId) const;
 
        std::uint16_t get_active_mask() const;
 
        const std::deque<std::uint16_t> &get_mask_history() const;
 
        std::size_t get_max_mask_history_size() const;
 
        void set_max_mask_history_size(std::size_t size);
 
        void add_tracked_soft_key_mask(std::uint16_t dataOrAlarmMaskId, std::uint16_t initialSoftKeyMaskId = 0);
 
        void remove_tracked_soft_key_mask(std::uint16_t dataOrAlarmMaskId);
 
        std::uint16_t get_active_soft_key_mask() const;
 
        std::uint16_t get_soft_key_mask(std::uint16_t dataOrAlarmMaskId) const;
 
        bool is_working_set_active() const;
 
        void add_tracked_attribute(std::uint16_t objectId, std::uint8_t attribute, std::uint32_t initialValue = 0);
 
        void remove_tracked_attribute(std::uint16_t objectId, std::uint8_t attribute);
 
        std::uint32_t get_attribute(std::uint16_t objectId, std::uint8_t attribute) const;
 
    protected:
        std::shared_ptr<ControlFunction> client; 
        std::shared_ptr<ControlFunction> server; 
 
        std::map<std::uint16_t, std::uint32_t> numericValueStates; 
        std::uint16_t activeDataOrAlarmMask = NULL_OBJECT_ID; 
        std::deque<std::uint16_t> dataAndAlarmMaskHistory; 
        std::size_t maxDataAndAlarmMaskHistorySize = 100; 
        std::uint8_t activeWorkingSetAddress = NULL_CAN_ADDRESS; 
        std::map<std::uint16_t, std::uint16_t> softKeyMasks; 
        std::map<std::uint16_t, std::map<std::uint8_t, std::uint32_t>> attributeStates; 
 
    private:
        void cache_active_mask(std::uint16_t maskId);
 
        static void process_rx_or_tx_message(const CANMessage &message, void *parentPointer);
 
        void process_status_message(const CANMessage &message);
 
        void process_message_from_connected_server(const CANMessage &message);
 
        void process_message_to_connected_server(const CANMessage &message);
 
        struct ChangeAttributeCommand
        {
            std::uint32_t value; 
            std::uint16_t objectId; 
            std::uint8_t attribute; 
        };
 
        std::map<std::shared_ptr<ControlFunction>, ChangeAttributeCommand> pendingChangeAttributeCommands; 
    };
} // namespace isobus
 
#endif // ISOBUS_VIRTUAL_TERMINAL_CLIENT_STATE_TRACKER_HPP