ToolsMessage.h

//
// Copyright 2014 - 2025 (C). Alex Robenko. All rights reserved.
//
 
// This file is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
#pragma once
 
#include "cc_tools_qt/ToolsApi.h"
#include "cc_tools_qt/ToolsField.h"
 
#include "comms/ErrorStatus.h"
 
#include <QtCore/QObject>
#include <QtCore/QVariantList>
#include <QtCore/QVariantMap>
 
#include <cstdint>
#include <list>
#include <memory>
#include <vector>
 
namespace cc_tools_qt
{
 
class ToolsFrame;
 
class CC_TOOLS_API ToolsMessage : public QObject
{
    using Base = QObject;
public:
    using Ptr = std::unique_ptr<ToolsMessage>;
 
    using DataSeq = std::vector<std::uint8_t>;
 
    using FieldsList = std::vector<ToolsFieldPtr>;
 
    enum class Type {
        Invalid, 
        Received, 
        Sent, 
        NumOfValues 
    };
 
    virtual ~ToolsMessage() noexcept;
 
    const char* name() const;
 
    bool refreshMsg();
 
    QString idAsString() const;
 
    qlonglong numericId() const;
 
    void reset();
 
    bool assign(const ToolsMessage& other);
 
    bool isValid() const;
 
    DataSeq encodeData() const;
 
    bool decodeData(const DataSeq& data);
 
    Ptr clone() const;
 
    void assignProtMessage(void* protMsg);
 
    DataSeq encodeFramed(ToolsFrame& frame) const;
 
    FieldsList transportFields();
    FieldsList payloadFields();
 
protected:
 
    ToolsMessage();
 
    virtual const char* nameImpl() const = 0;
 
    virtual bool refreshMsgImpl() = 0;
 
    virtual qlonglong numericIdImpl() const = 0;    
 
    virtual QString idAsStringImpl() const;
 
    virtual void resetImpl() = 0;
 
    virtual bool assignImpl(const ToolsMessage& other) = 0;
 
    virtual bool isValidImpl() const = 0;
 
    virtual DataSeq encodeDataImpl() const = 0;
 
    virtual bool decodeDataImpl(const DataSeq& data) = 0;
 
    virtual Ptr cloneImpl() const = 0;
 
    virtual void assignProtMessageImpl(void* protMsg) = 0;
 
    virtual DataSeq encodeFramedImpl(ToolsFrame& frame) const = 0;
 
    virtual FieldsList transportFieldsImpl() = 0;
    virtual FieldsList payloadFieldsImpl() = 0;
};
 
using ToolsMessagePtr = std::shared_ptr<ToolsMessage>;
using ToolsMessagesList = std::list<ToolsMessagePtr>;
 
}  // namespace cc_tools_qt
 
Q_DECLARE_METATYPE(cc_tools_qt::ToolsMessagePtr);
Q_DECLARE_METATYPE(cc_tools_qt::ToolsMessagesList);
Q_DECLARE_METATYPE(cc_tools_qt::ToolsMessage::DataSeq);
Q_DECLARE_METATYPE(cc_tools_qt::ToolsMessage::Type);