CParamOnline.hpp

Go to the documentation of this file.

#ifndef LIBS_LOGIC_CPARAMONLINE_HPP_
#define LIBS_LOGIC_CPARAMONLINE_HPP_
 
#include "comms/ECommunications.hpp"
#include "logic/structs.hpp"
 
#include <bits/stdint-uintn.h>
#include <memory>
#include <string>
 
class CParamOnline
{
public:
    static bool sortByParamOrderInLogic(const std::weak_ptr<CParamOnline> &paramA,
                                        const std::weak_ptr<CParamOnline> &paramB);
 
    CParamOnline(std::string_view tag, uint16_t orderInBlock, std::string_view externalTag,
                 std::string_view externalTag2, uint8_t type, uint8_t size, std::string_view libraryBlockTagName,
                 iv::types::unitId logicUnitId);
 
    CParamOnline(std::string_view tag, uint16_t orderInBlock, std::string_view externalTag,
                 std::string_view externalTag2, uint8_t type, uint8_t size, uint16_t blockOrder, uint32_t orderInLogic,
                 uint32_t value, std::string_view libraryBlockTagName, iv::types::unitId logicUnitId);
 
    explicit CParamOnline(const CParamOnline *param);
    CParamOnline() = default;
    ~CParamOnline() = default;
    CParamOnline(const CParamOnline &other) = delete;
    CParamOnline(CParamOnline &&other) = delete;
    CParamOnline &operator=(const CParamOnline &other) = delete;
    CParamOnline &operator=(CParamOnline &&other) = delete;
 
    void extractParamValues(const iv::logic::formulaLogic::SBlockParam &blockParam, uint32_t orderInLogic,
                            uint16_t orderOfBlock);
 
    iv::comms::eResponse downloadChangeValue(float value);
    iv::comms::eResponse uploadValue();
 
    [[nodiscard]] iv::types::logic::parameterOnlineTag getTag() const;
    [[nodiscard]] iv::types::logic::libraryTagName getLibraryBlockTagName() const;
    [[nodiscard]] std::string getExternalTag() const;
    [[nodiscard]] std::string getExternalTag2() const;
    [[nodiscard]] uint16_t getBlockOrder() const;
    [[nodiscard]] uint16_t getParameterNr() const;
    [[nodiscard]] uint16_t getParameterOrderInLogic() const;
    [[nodiscard]] double getPrecisionParameter() const;
    [[nodiscard]] uint8_t getSize() const;
    [[nodiscard]] uint8_t getType() const;
    [[nodiscard]] iv::logic::eDBBlockParamType getEnumType() const;
    [[nodiscard]] uint32_t getLiteralValue() const;
    [[nodiscard]] float getTypedValue() const;
    [[nodiscard]] std::string getValueToString() const;
    [[nodiscard]] bool isCorrectlyUploaded() const;
 
    [[nodiscard]] iv::types::externalParameterOnlineId generateExternalParamOnlineId() const;
 
    void setTag(std::string_view paramOnlineTag);
    void setLibraryBlockTagName(std::string_view libraryTagName);
    void setExternalTag(std::string_view externalTag);
    void setExternalTag2(std::string_view externalTag2);
 
    // private:
    iv::types::logic::parameterOnlineTag m_tag {};
 
    uint16_t m_orderInBlock {};
 
    iv::types::logic::parameterOnlineTag m_externalTag {};
    iv::types::logic::parameterOnlineTag m_externalTag2 {};
 
    uint8_t m_type {};
    uint8_t m_size {};
 
    uint16_t m_unpackedBlockOrder {};// Block order after unpacking library blocks.
    uint32_t m_orderInLogic {};      // Order in logic.
 
    uint32_t m_value {};// Literal value. Can be uchar, ushort or float.
    bool m_correctlyUploaded {false};
 
    iv::types::logic::libraryTagName m_libraryBlockTagName {};
    iv::types::unitId m_idUnit {};
};
 
#endif /* LIBS_LOGIC_CPARAMONLINE_HPP_ */