isobus_device_descriptor_object_pool.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
 
#ifndef ISOBUS_DEVICE_DESCRIPTOR_OBJECT_POOL_HPP
#define ISOBUS_DEVICE_DESCRIPTOR_OBJECT_POOL_HPP
 
#include "isobus/isobus/can_NAME.hpp"
#include "isobus/isobus/isobus_task_controller_client_objects.hpp"
 
#include <memory>
 
namespace isobus
{
    class DeviceDescriptorObjectPool
    {
    public:
        DeviceDescriptorObjectPool() = default;
 
        explicit DeviceDescriptorObjectPool(std::uint8_t taskControllerServerVersion);
 
        bool add_device(std::string deviceDesignator,
                        std::string deviceSoftwareVersion,
                        std::string deviceSerialNumber,
                        std::string deviceStructureLabel,
                        std::array<std::uint8_t, task_controller_object::DeviceObject::MAX_STRUCTURE_AND_LOCALIZATION_LABEL_LENGTH> deviceLocalizationLabel,
                        std::vector<std::uint8_t> deviceExtendedStructureLabel,
                        std::uint64_t clientIsoNAME);
 
        bool add_device_element(std::string deviceElementDesignator,
                                std::uint16_t deviceElementNumber,
                                std::uint16_t parentObjectID,
                                task_controller_object::DeviceElementObject::Type deviceElementType,
                                std::uint16_t uniqueID);
 
        bool add_device_process_data(std::string processDataDesignator,
                                     std::uint16_t processDataDDI,
                                     std::uint16_t deviceValuePresentationObjectID,
                                     std::uint8_t processDataProperties,
                                     std::uint8_t processDataTriggerMethods,
                                     std::uint16_t uniqueID);
 
        bool add_device_property(std::string propertyDesignator,
                                 std::int32_t propertyValue,
                                 std::uint16_t propertyDDI,
                                 std::uint16_t valuePresentationObject,
                                 std::uint16_t uniqueID);
 
        bool add_device_value_presentation(std::string unitDesignator,
                                           std::int32_t offsetValue,
                                           float scaleFactor,
                                           std::uint8_t numberDecimals,
                                           std::uint16_t uniqueID);
 
        bool deserialize_binary_object_pool(std::vector<std::uint8_t> &binaryPool, NAME clientNAME = NAME(0));
 
        bool deserialize_binary_object_pool(const std::uint8_t *binaryPool, std::uint32_t binaryPoolSizeBytes, NAME clientNAME = NAME(0));
 
        bool generate_binary_object_pool(std::vector<std::uint8_t> &resultantPool);
 
        bool generate_task_data_iso_xml(std::string &resultantString);
 
        std::shared_ptr<task_controller_object::Object> get_object_by_id(std::uint16_t objectID);
 
        std::shared_ptr<task_controller_object::Object> get_object_by_index(std::uint16_t index);
 
        bool remove_object_by_id(std::uint16_t objectID);
 
        void set_task_controller_compatibility_level(std::uint8_t tcVersion);
 
        std::uint8_t get_task_controller_compatibility_level() const;
 
        static std::uint8_t get_max_supported_task_controller_version();
 
        void clear();
 
        std::uint16_t size() const;
 
    private:
        bool resolve_parent_ids_to_objects();
 
        bool check_object_id_unique(std::uint16_t uniqueID) const;
 
        static constexpr std::uint8_t MAX_TC_VERSION_SUPPORTED = 4; 
 
        std::vector<std::shared_ptr<task_controller_object::Object>> objectList; 
        std::uint8_t taskControllerCompatibilityLevel = MAX_TC_VERSION_SUPPORTED; 
    };
} // namespace isobus
 
#endif // ISOBUS_DEVICE_DESCRIPTOR_OBJECT_POOL_HPP