summaryrefslogtreecommitdiffstats
path: root/src/knx/knxproj/qknxgroupaddresses_p.h
blob: 5e9936474c801775cd468a0339667eba3dba6ebb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/******************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtKnx module.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
******************************************************************************/

#ifndef QKNXGROUPADDRESSES_P_H
#define QKNXGROUPADDRESSES_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt KNX API.  It exists for the convenience
// of the Qt KNX implementation.  This header file may change from version
// to version without notice, or even be removed.
//
// We mean it.
//

#include <QtCore/qstring.h>
#include <QtCore/qvector.h>
#include <QtKnx/private/qknxprojectutils_p.h>

QT_BEGIN_NAMESPACE

struct Q_KNX_EXPORT QKnxGroupAddress
{
    Q_DECLARE_TR_FUNCTIONS(QKnxGroupAddress)

public:
    QKnxGroupAddress() = default;
    QKnxGroupAddress(const QString &id, quint32 address, const QString &name, qint32 puid)
        : Id(id), Address(address), Name(name), Puid(puid)
    {}
    QString Id; // non-colonized name, pattern [\i-[:]][\c-[:]]*
    quint32 Address; // min. value 1, 65535 value max.
    QString Name; // 255 character max.
    bool Unfiltered { false }; // optional
    bool Central { false }; // optional
    bool Global { false }; // optional
    QString DatapointType; // optional, non-colonized name, pattern [\i-[:]][\c-[:]]*
    QString Description; // optional
    QString Comment; // optional
    qint32 Puid;
    QString Key; // optional, 40 character max.
    QString Security { QLatin1String("Auto") }; // optional, Auto, On, Off

    bool parseElement(QXmlStreamReader *reader, bool pedantic);

    bool operator==(const QKnxGroupAddress &other) const
    {
        return Id == other.Id
            && Address == other.Address
            && Name == other.Name
            && Unfiltered == other.Unfiltered
            && Central == other.Central
            && Global == other.Global
            && DatapointType == other.DatapointType
            && Description == other.Description
            && Comment == other.Comment
            && Puid == other.Puid
            && Key == other.Key
            && Security == other.Security;
    }

    bool operator!=(const QKnxGroupAddress &other) const
    {
        return !operator==(other);
    }
};

struct Q_KNX_EXPORT QKnxGroupRange
{
    Q_DECLARE_TR_FUNCTIONS(QKnxGroupRange)

public:
    ~QKnxGroupRange() noexcept = default;

    QString Id; // non-colonized name, pattern [\i-[:]][\c-[:]]*
    QString Name; // 255 character max.
    quint16 RangeStart { 0 };
    quint16 RangeEnd { 0 };
    bool Unfiltered { false }; // optional
    QString Description; // optional
    QString Comment; // optional
    qint32 Puid { 0 };
    QString Security { QLatin1String("Auto") }; // optional, Auto, On, Off

    QVector<QKnxGroupRange> GroupRange; // 0..65535
    QVector<QKnxGroupAddress> GroupAddress; // 0..65535

    bool parseElement(QXmlStreamReader *reader, bool pedantic);
};

struct Q_KNX_EXPORT QKnxGroupAddresses
{
    Q_DECLARE_TR_FUNCTIONS(QKnxGroupAddresses)

public:
    QVector<QKnxGroupRange> GroupRanges; // 0..65535

    bool parseElement(QXmlStreamReader *reader, bool pedantic);
};

QT_END_NAMESPACE

#endif