summaryrefslogtreecommitdiffstats
path: root/src/opcua/client/qopcuahistorydata.cpp
blob: 4a71a47e71dc485ba552b40ccc22323dfb558b46 (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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/****************************************************************************
**
** Copyright (C) 2019 basysKom GmbH, opensource@basyskom.com
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtOpcUa module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qopcuahistorydata.h"

QT_BEGIN_NAMESPACE

/*!
    \class QOpcUaHistoryData
    \inmodule QtOpcUa
    \brief This class stores historical data values from a node.

    When a request to read history data is being handled, instances of this class
    are used to store information about which node has been read, its values and
    the status code.
    The finished signal of a history read request will return a list of QOpcUaHistoryData
    objects which can be parsed to review the results of the request.
*/

class QOpcUaHistoryDataData : public QSharedData
{
public:
    QList<QOpcUaDataValue> result;
    QOpcUa::UaStatusCode statusCode;
    QString nodeId;
};

QOpcUaHistoryData::QOpcUaHistoryData()
    : data(new QOpcUaHistoryDataData)
{
    data->statusCode = QOpcUa::UaStatusCode::Good;
}

/*!
    Constructs a history data item and stores which node it corresponds to.
*/
QOpcUaHistoryData::QOpcUaHistoryData(const QString &nodeId)
    : data(new QOpcUaHistoryDataData)
{
    data->statusCode = QOpcUa::UaStatusCode::Good;
    data->nodeId = nodeId;
}

/*!
    Constructs a history data item from \a other.
*/
QOpcUaHistoryData::QOpcUaHistoryData(const QOpcUaHistoryData &other)
    : data(other.data)
{
}

QOpcUaHistoryData::~QOpcUaHistoryData()
{
}

/*!
    Returns the status code which indicates if an error occurred while fetching the history data.
*/
QOpcUa::UaStatusCode QOpcUaHistoryData::statusCode() const
{
    return data->statusCode;
}

/*!
    Sets the status code to \a statusCode.
*/
void QOpcUaHistoryData::setStatusCode(QOpcUa::UaStatusCode statusCode)
{
    data->statusCode = statusCode;
}

/*!
    Returns the list of data value objects which contain the results of the history read request.
*/
QList<QOpcUaDataValue> QOpcUaHistoryData::result() const
{
    return data->result;
}

/*!
   Returns a reference to the result list.
*/
QList<QOpcUaDataValue> &QOpcUaHistoryData::resultRef()
{
    return data->result;
}

/*!
    Returns the number of available data value objects.
*/
int QOpcUaHistoryData::count() const
{
    return data->result.count();
}

/*!
    Adds a data value object given by \a value.
*/
void QOpcUaHistoryData::addValue(const QOpcUaDataValue &value)
{
    data->result.append(value);
}

/*!
    Returns the nodeId of the node whose data has been stored.
*/
QString QOpcUaHistoryData::nodeId() const
{
    return data->nodeId;
}

/*!
    Sets the nodeId to \a nodeId.
*/
void QOpcUaHistoryData::setNodeId(const QString &nodeId)
{
    data->nodeId = nodeId;
}

/*!
    Sets the values from \a rhs in this history data item.
*/
QOpcUaHistoryData &QOpcUaHistoryData::operator=(const QOpcUaHistoryData &rhs)
{
    if (this != &rhs)
        data.operator=(rhs.data);
    return *this;
}

QT_END_NAMESPACE