cc_tools_qt
Common Environment for Protocol Analysis.
Loading...
Searching...
No Matches
ToolsFrame.h
1//
2// Copyright 2024 - 2025 (C). Alex Robenko. All rights reserved.
3//
4
5// This file is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// This program is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18
19#pragma once
20
21#include "cc_tools_qt/ToolsApi.h"
22#include "cc_tools_qt/ToolsDataInfo.h"
23#include "cc_tools_qt/ToolsMessage.h"
24#include "cc_tools_qt/version.h"
25
26#include <memory>
27#include <list>
28
29namespace cc_tools_qt
30{
31
32class CC_TOOLS_API ToolsFrame
33{
34public:
35 using DataSeq = ToolsMessage::DataSeq;
36
37 virtual ~ToolsFrame();
38
39 ToolsMessagesList readData(const ToolsDataInfo& dataInfo, bool final);
40 void updateMessage(ToolsMessage& msg);
41 ToolsMessagePtr createInvalidMessage();
42 ToolsMessagePtr createRawDataMessage();
43 ToolsMessagePtr createExtraInfoMessage();
44 ToolsMessagesList createAllMessages();
45 ToolsMessagePtr createMessage(const QString& idAsString, unsigned idx);
46 DataSeq writeProtMsg(const void* protInterface);
47
48protected:
49 ToolsFrame() = default;
50
51 virtual ToolsMessagesList readDataImpl(const ToolsDataInfo& dataInfo, bool final) = 0;
52 virtual void updateMessageImpl(ToolsMessage& msg) = 0;
53 virtual ToolsMessagePtr createInvalidMessageImpl() = 0;
54 virtual ToolsMessagePtr createRawDataMessageImpl() = 0;
55 virtual ToolsMessagePtr createExtraInfoMessageImpl() = 0;
56 virtual ToolsMessagesList createAllMessagesImpl() = 0;
57 virtual ToolsMessagePtr createMessageImpl(const QString& idAsString, unsigned idx) = 0;
58 virtual DataSeq writeProtMsgImpl(const void* protInterface) = 0;
59};
60
61using ToolsFramePtr = std::unique_ptr<ToolsFrame>;
62
63} // namespace cc_tools_qt
64
65
Main namespace for all classes / functions of the shared library.
std::shared_ptr< ToolsMessage > ToolsMessagePtr
Smart pointer to ToolsMessage.
Definition ToolsMessage.h:164