isobus_language_command_interface.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
#ifndef ISOBUS_LANGUAGE_COMMAND_INTERFACE_HPP
#define ISOBUS_LANGUAGE_COMMAND_INTERFACE_HPP
 
#include "isobus/isobus/can_callbacks.hpp"
#include "isobus/isobus/can_message.hpp"
 
#include <memory>
#include <string>
 
namespace isobus
{
    class InternalControlFunction;
    class PartneredControlFunction;
    class ControlFunction;
 
    class LanguageCommandInterface
    {
    public:
        enum class DecimalSymbols : std::uint8_t
        {
            Comma = 0, 
            Point = 1, 
            Reserved = 2, 
            NoAction = 3 
        };
 
        enum class DateFormats : std::uint8_t
        {
            ddmmyyyy = 0, 
            ddyyyymm = 1, 
            mmyyyydd = 2, 
            mmddyyyy = 3, 
            yyyymmdd = 4, 
            yyyyddmm = 5, 
 
            ReservedStart = 6, 
            ReservedEnd = 250 
        };
 
        enum class TimeFormats : std::uint8_t
        {
            TwentyFourHour = 0, 
            TwelveHourAmPm = 1, 
            Reserved = 2, 
            NoAction = 3 
        };
 
        enum class DistanceUnits : std::uint8_t
        {
            Metric = 0, 
            ImperialUS = 1, 
            Reserved = 2, 
            NoAction = 3 
        };
 
        enum class AreaUnits : std::uint8_t
        {
            Metric = 0, 
            ImperialUS = 1, 
            Reserved = 2, 
            NoAction = 3 
        };
 
        enum class VolumeUnits : std::uint8_t
        {
            Metric = 0, 
            Imperial = 1, 
            US = 2, 
            NoAction = 3 
        };
 
        enum class MassUnits : std::uint8_t
        {
            Metric = 0, 
            Imperial = 1, 
            US = 2, 
            NoAction = 3 
        };
 
        enum class TemperatureUnits : std::uint8_t
        {
            Metric = 0, 
            ImperialUS = 1, 
            Reserved = 2, 
            NoAction = 3 
        };
 
        enum class PressureUnits : std::uint8_t
        {
            Metric = 0, 
            ImperialUS = 1, 
            Reserved = 2, 
            NoAction = 3 
        };
 
        enum class ForceUnits : std::uint8_t
        {
            Metric = 0, 
            ImperialUS = 1, 
            Reserved = 2, 
            NoAction = 3 
        };
 
        enum class UnitSystem : std::uint8_t
        {
            Metric = 0, 
            Imperial = 1, 
            US = 2, 
            NoAction = 3 
        };
 
        LanguageCommandInterface(std::shared_ptr<InternalControlFunction> sourceControlFunction, bool shouldRespondToRequests = false);
 
        LanguageCommandInterface(std::shared_ptr<InternalControlFunction> sourceControlFunction, std::shared_ptr<PartneredControlFunction> filteredControlFunction);
 
        LanguageCommandInterface(LanguageCommandInterface &) = delete;
 
        ~LanguageCommandInterface();
 
        void initialize();
 
        void set_partner(std::shared_ptr<PartneredControlFunction> filteredControlFunction);
 
        std::shared_ptr<PartneredControlFunction> get_partner() const;
 
        bool get_initialized() const;
 
        bool send_request_language_command() const;
 
        bool send_language_command();
 
        std::string get_country_code() const;
 
        void set_country_code(std::string country);
 
        std::string get_language_code() const;
 
        void set_language_code(std::string language);
 
        std::uint32_t get_language_command_timestamp() const;
 
        DecimalSymbols get_commanded_decimal_symbol() const;
 
        void set_commanded_decimal_symbol(DecimalSymbols decimals);
 
        TimeFormats get_commanded_time_format() const;
 
        void set_commanded_time_format(TimeFormats format);
 
        DateFormats get_commanded_date_format() const;
 
        void set_commanded_date_format(DateFormats format);
 
        DistanceUnits get_commanded_distance_units() const;
 
        void set_commanded_distance_units(DistanceUnits units);
 
        AreaUnits get_commanded_area_units() const;
 
        void set_commanded_area_units(AreaUnits units);
 
        VolumeUnits get_commanded_volume_units() const;
 
        void set_commanded_volume_units(VolumeUnits units);
 
        MassUnits get_commanded_mass_units() const;
 
        void set_commanded_mass_units(MassUnits units);
 
        TemperatureUnits get_commanded_temperature_units() const;
 
        void set_commanded_temperature_units(TemperatureUnits units);
 
        PressureUnits get_commanded_pressure_units() const;
 
        void set_commanded_pressure_units(PressureUnits units);
 
        ForceUnits get_commanded_force_units() const;
 
        void set_commanded_force_units(ForceUnits units);
 
        UnitSystem get_commanded_generic_units() const;
 
        void set_commanded_generic_units(UnitSystem units);
 
        const std::array<std::uint8_t, 7> get_localization_raw_data() const;
 
        static void process_rx_message(const CANMessage &message, void *parentPointer);
 
    private:
        static bool on_language_request(std::uint32_t parameterGroupNumber,
                                        std::shared_ptr<ControlFunction> requestingControlFunction,
                                        bool &acknowledge,
                                        AcknowledgementType &acknowledgeType,
                                        void *parentPointer);
 
        std::shared_ptr<InternalControlFunction> myControlFunction; 
        std::shared_ptr<PartneredControlFunction> myPartner; 
        std::string countryCode; 
        std::string languageCode; 
        std::uint32_t languageCommandTimestamp_ms = 0; 
        DecimalSymbols decimalSymbol = DecimalSymbols::Point; 
        TimeFormats timeFormat = TimeFormats::TwelveHourAmPm; 
        DateFormats dateFormat = DateFormats::mmddyyyy; 
        DistanceUnits distanceUnitSystem = DistanceUnits::Metric; 
        AreaUnits areaUnitSystem = AreaUnits::Metric; 
        VolumeUnits volumeUnitSystem = VolumeUnits::Metric; 
        MassUnits massUnitSystem = MassUnits::Metric; 
        TemperatureUnits temperatureUnitSystem = TemperatureUnits::Metric; 
        PressureUnits pressureUnitSystem = PressureUnits::Metric; 
        ForceUnits forceUnitSystem = ForceUnits::Metric; 
        UnitSystem genericUnitSystem = UnitSystem::Metric; 
        bool initialized = false; 
        bool respondToRequests = false; 
    };
} // namespace isobus
 
#endif // ISOBUS_LANGUAGE_COMMAND_INTERFACE_HPP