isobus_device_descriptor_object_pool_helpers.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
 
#ifndef ISOBUS_DEVICE_DESCRIPTOR_OBJECT_POOL_HELPERS_HPP
#define ISOBUS_DEVICE_DESCRIPTOR_OBJECT_POOL_HELPERS_HPP
 
#include "isobus/isobus/can_constants.hpp"
#include "isobus/isobus/isobus_device_descriptor_object_pool.hpp"
#include "isobus/isobus/isobus_standard_data_description_indices.hpp"
 
namespace isobus
{
    class DeviceDescriptorObjectPoolHelper
    {
    public:
        class ObjectPoolValue
        {
        public:
            ObjectPoolValue() = default;
 
            explicit operator bool() const;
 
            bool exists() const;
 
            bool editable() const;
 
            std::int32_t get() const;
 
        protected:
            friend class DeviceDescriptorObjectPoolHelper; 
 
            std::int32_t value = 0; 
            bool isValuePresent = false; 
            bool isSettable = false; 
        };
 
        class RateMetadata : public ObjectPoolValue
        {
        public:
            std::uint16_t dataDictionaryIdentifier = static_cast<std::uint16_t>(DataDescriptionIndex::Reserved); 
            std::uint16_t objectID = NULL_OBJECT_ID; 
 
        protected:
            friend class DeviceDescriptorObjectPoolHelper; 
        };
 
        class ProductControlInformation
        {
        public:
            bool is_valid() const;
 
            RateMetadata rateSetpoint; 
            RateMetadata rateActual; 
            RateMetadata rateDefault; 
            RateMetadata rateMinimum; 
            RateMetadata rateMaximum; 
            std::uint16_t elementNumber = NULL_OBJECT_ID; 
        };
 
        class Section
        {
        public:
            ObjectPoolValue xOffset_mm; 
            ObjectPoolValue yOffset_mm; 
            ObjectPoolValue zOffset_mm; 
            ObjectPoolValue width_mm; 
            std::vector<ProductControlInformation> rates; 
            std::uint16_t elementNumber = NULL_OBJECT_ID; 
        };
 
        class SubBoom
        {
        public:
            std::vector<Section> sections; 
            std::vector<ProductControlInformation> rates; 
            ObjectPoolValue xOffset_mm; 
            ObjectPoolValue yOffset_mm; 
            ObjectPoolValue zOffset_mm; 
            ObjectPoolValue width_mm; 
            std::uint16_t elementNumber = NULL_OBJECT_ID; 
        };
 
        class Boom
        {
        public:
            std::vector<Section> sections; 
            std::vector<SubBoom> subBooms; 
            std::vector<ProductControlInformation> rates; 
            ObjectPoolValue xOffset_mm; 
            ObjectPoolValue yOffset_mm; 
            ObjectPoolValue zOffset_mm; 
            std::uint16_t elementNumber = NULL_OBJECT_ID; 
        };
 
        class Implement
        {
        public:
            std::vector<Boom> booms; 
        };
 
        static Implement get_implement_geometry(DeviceDescriptorObjectPool &ddop);
 
    private:
        static void parse_element(DeviceDescriptorObjectPool &ddop,
                                  std::shared_ptr<task_controller_object::DeviceElementObject> elementObject,
                                  Implement &implementToPopulate);
 
        static Section parse_section(DeviceDescriptorObjectPool &ddop,
                                     std::shared_ptr<task_controller_object::DeviceElementObject> elementObject);
 
        static SubBoom parse_sub_boom(DeviceDescriptorObjectPool &ddop,
                                      std::shared_ptr<task_controller_object::DeviceElementObject> elementObject);
 
        static ProductControlInformation parse_bin(DeviceDescriptorObjectPool &ddop,
                                                   std::shared_ptr<task_controller_object::DeviceElementObject> elementObject);
 
        static void set_value_from_property(ObjectPoolValue &objectPoolValue,
                                            const std::shared_ptr<task_controller_object::DevicePropertyObject> &property,
                                            DataDescriptionIndex ddi);
 
        static void set_editable_from_process_data(ObjectPoolValue &objectPoolValue,
                                                   const std::shared_ptr<task_controller_object::DeviceProcessDataObject> &processData,
                                                   DataDescriptionIndex ddi);
 
        static void set_product_control_information_max_rate(ProductControlInformation &productControlInformation,
                                                             const std::shared_ptr<task_controller_object::Object> &object,
                                                             std::uint16_t ddi);
 
        static void set_product_control_information_min_rate(ProductControlInformation &productControlInformation,
                                                             const std::shared_ptr<task_controller_object::Object> &object,
                                                             std::uint16_t ddi);
 
        static void set_product_control_information_default_rate(ProductControlInformation &productControlInformation,
                                                                 const std::shared_ptr<task_controller_object::Object> &object,
                                                                 std::uint16_t ddi);
 
        static void set_product_control_information_setpoint_rate(ProductControlInformation &productControlInformation,
                                                                  const std::shared_ptr<task_controller_object::Object> &object,
                                                                  std::uint16_t ddi);
 
        static void set_product_control_information_actual_rate(ProductControlInformation &productControlInformation,
                                                                const std::shared_ptr<task_controller_object::Object> &object,
                                                                std::uint16_t ddi);
    };
} // namespace isobus
 
#endif // ISOBUS_DEVICE_DESCRIPTOR_OBJECT_POOL_HELPERS_HPP