| qopcuaaddnodeitem.cpp |
!
\class QOpcUaAddNodeItem
\inmodule QtOpcUa
\brief This class stores the necessary information to create a new node on the server.
\sa QOpcUaClient::addNode()
|
4447 |
- |
| qopcuaaddnodeitem.h |
|
1718 |
- |
| qopcuaaddreferenceitem.cpp |
!
\class QOpcUaAddReferenceItem
\inmodule QtOpcUa
\brief This class stores the necessary information to add a new reference on the server.
\sa QOpcUaClient::addReference()
|
3862 |
- |
| qopcuaaddreferenceitem.h |
|
1511 |
- |
| qopcuaapplicationdescription.cpp |
!
\class QOpcUaApplicationDescription
\inmodule QtOpcUa
\brief The OPC UA ApplicationDescription.
The application description contains information about an OPC UA application.
|
7700 |
- |
| qopcuaapplicationdescription.h |
|
2483 |
- |
| qopcuaapplicationidentity.cpp |
!
\class QOpcUaApplicationIdentity
\inmodule QtOpcUa
\since QtOpcUa 5.13
\brief QOpcUaApplicationIdentity defines the identity of the application.
This info must be configured using \l QOpcUaClient::setApplicationIdentity.
The application identity can be set up manually or derived from a certificate.
\code
QOpcUaApplicationIdentity identity;
const QString applicationUri = QStringLiteral("urn:%1:%2:%3")
.arg(QHostInfo::localHostName())
.arg(QCoreApplication::organizationName())
.arg(QCoreApplication::applicationName());
const QString productUri = QStringLiteral("urn:%1:%2")
.arg(QCoreApplication::organizationName())
.arg(QCoreApplication::applicationName());
identity.setProductUri(productUri);
identity.setApplicationUri(applicationUri);
identity.setApplicationName(QCoreApplication::applicationName());
identity.setApplicationType(QOpcUaApplicationDescription::Client);
client->setApplicationIdentity(identity);
\endcode
In case your application authenticates using certificates the application identity has to match
the used certificate. In this case all information is extracted from the certificate given in the
PKI configuration.
\code
QOpcUaApplicationIdentity identity;
identity = pkiConfig.applicationIdentity();
\endcode
|
4729 |
- |
| qopcuaapplicationidentity.h |
|
1368 |
- |
| qopcuaapplicationrecorddatatype.cpp |
!
\class QOpcUaApplicationRecordDataType
\inmodule QtOpcUa
\brief The OPC UA ApplicationRecordDataType.
\since 5.14
This class is currently available as a Technology Preview, and therefore the API
and functionality provided by the class may be subject to change at any time without
prior notice.
This is the Qt OPC UA representation for the OPC UA ApplicationRecordDataType type defined in OPC UA version 1.05 part 12, 6.6.5.
It is used to represent a record in the GDS.
|
5460 |
- |
| qopcuaapplicationrecorddatatype.h |
|
2007 |
- |
| qopcuaargument.cpp |
!
\class QOpcUaArgument
\inmodule QtOpcUa
\brief The OPC UA Argument type.
This is the Qt OPC UA representation for the Argument type defined in OPC UA 1.05 part 3, 8.6.
The Argument type is mainly used for the values of the InputArguments and OutputArguments properties
which describe the parameters and return values of method nodes.
|
4834 |
- |
| qopcuaargument.h |
|
1531 |
- |
| qopcuaattributeoperand.cpp |
!
\class QOpcUaAttributeOperand
\inmodule QtOpcUa
\brief The OPC UA AttributeOperand type.
The AttributeOperand is defined in OPC UA 1.05 part 4, 7.7.4.4.
It has the same purpose as \l QOpcUaSimpleAttributeOperand but has more configurable options.
|
4407 |
- |
| qopcuaattributeoperand.h |
|
2034 |
- |
| qopcuaauthenticationinformation.cpp |
!
\class QOpcUaAuthenticationInformation
\inmodule QtOpcUa
\brief The OPC UA authentication information.
\since QtOpcUa 5.13
This class holds the information necessary to perform a login on a server.
Supported authentication mechanisms are
\list
\li Anonymous
\li Username
\li Certificate
\endlist
The anonymous method is used by default but also can be set manually.
This is an example authentication using username and password.
\code
QOpcUaAuthenticationInformation authInfo;
authInfo.setUsernameAuthentication("user", "password");
m_client->setAuthenticationInformation(authInfo);
m_client->connectToEndpoint(endpoint);
\endcode
\sa setAnonymousAuthentication() setUsernameAuthentication() setCertificateAuthentication()
|
5468 |
- |
| qopcuaauthenticationinformation.h |
|
1510 |
- |
| qopcuaaxisinformation.cpp |
!
\class QOpcUaAxisInformation
\inmodule QtOpcUa
\brief The OPC UA AxisInformation type.
This is the Qt OPC UA representation for the OPC UA AxisInformation type defined in OPC UA 1.05 part 8, 5.6.6.
It contains information about an axis which can be used for multiple purposes. A common use case could
involve the plotting of display data. The engineering units and the title are used for the text on the plot,
range, axisScaleType and axisSteps provide the scaling and the axis ranges of the plot.
|
5037 |
- |
| qopcuaaxisinformation.h |
|
1734 |
- |
| qopcuabackend.cpp |
!
This function returns \l QOpcUaClient::ClientError::NoError if the given endpoint description is valid.
If \a message is not \nullptr, an error message will be assigned to it, in case
the endpoint description is invalid.
|
4127 |
- |
| qopcuabackend_p.h |
|
5071 |
- |
| qopcuabinarydataencoding.cpp |
|
51404 |
- |
| qopcuabinarydataencoding.h |
|
10749 |
- |
| qopcuabrowsepathtarget.cpp |
!
\class QOpcUaBrowsePathTarget
\inmodule QtOpcUa
\brief The OPC UA BrowsePathTarget.
A BrowsePathTarget contains a target of a browse path and information about the completeness of the node id resolution.
|
2983 |
- |
| qopcuabrowsepathtarget.h |
|
1200 |
- |
| qopcuabrowserequest.cpp |
!
\class QOpcUaBrowseRequest
\inmodule QtOpcUa
\brief Contains parameters for a call to the OPC UA browse service.
\sa QOpcUaNode::browse()
|
3364 |
- |
| qopcuabrowserequest.h |
|
1423 |
- |
| qopcuaclient.cpp |
!
\class QOpcUaClient
\inmodule QtOpcUa
\brief QOpcUaClient allows interaction with an OPC UA server.
\section1 QOpcUaClient
QOpcUaClient implements basic client capabilities to communicate with
OPC UA enabled devices and applications. This includes querying a discovery server
for known servers, requesting a list of endpoints from a server, connecting and
disconnecting.
After successfully connecting to a server, QOpcUaClient allows getting \l QOpcUaNode
objects which enable further interaction with nodes on the OPC UA server.
For operations that concern multiple nodes, QOpcUaClient offers an API which supports
reading multiple attributes of multiple nodes in a single request to the server.
QOpcUaClient also keeps a local copy of the server's namespace array which is created after
a successful connect. This information can be queried or updated while the connection lasts.
The copy of the namespace array is also used for the resolution of expanded node ids and the
creation of qualified names from a namespace URI.
\section1 Addressing Nodes
For an introduction to nodes and node ids, see \l QOpcUaNode.
\section1 Usage
Create a \l QOpcUaClient using \l QOpcUaProvider, request a list of endpoints from the server
using \l requestEndpoints and call \l connectToEndpoint() to connect to one of the available endpoints.
After the connection is established, a \l QOpcUaNode object for the root node is requested.
\code
QOpcUaProvider provider;
if (provider.availableBackends().isEmpty())
return;
QOpcUaClient *client = provider.createClient(provider.availableBackends()[0]);
if (!client)
return;
// Connect to the stateChanged signal. Compatible slots of QObjects can be used instead of a lambda.
QObject::connect(client, &QOpcUaClient::stateChanged, [client](QOpcUaClient::ClientState state) {
qDebug() << "Client state changed:" << state;
if (state == QOpcUaClient::ClientState::Connected) {
QOpcUaNode *node = client->node("ns=0;i=84");
if (node)
qDebug() << "A node object has been created";
}
});
QObject::connect(client, &QOpcUaClient::endpointsRequestFinished,
[client](QList<QOpcUaEndpointDescription> endpoints) {
qDebug() << "Endpoints returned:" << endpoints.count();
if (endpoints.size())
client->connectToEndpoint(endpoints.first()); // Connect to the first endpoint in the list
});
client->requestEndpoints(QUrl("opc.tcp://127.0.0.1:4840")); // Request a list of endpoints from the server
\endcode
|
44650 |
- |
| qopcuaclient.h |
|
6539 |
- |
| qopcuaclient_p.h |
|
2555 |
- |
| qopcuaclientimpl.cpp |
|
6572 |
- |
| qopcuaclientimpl_p.h |
|
5971 |
- |
| qopcuaclientprivate.cpp |
|
6086 |
- |
| qopcuacomplexnumber.cpp |
!
\class QOpcUaComplexNumber
\inmodule QtOpcUa
\brief The OPC UA ComplexNumber type.
The ComplexNumberType defined in OPC UA 1.05 part 8, 5.6.4.
It stores a complex number with float precision.
|
2413 |
- |
| qopcuacomplexnumber.h |
|
1074 |
- |
| qopcuaconnectionsettings.cpp |
!
\class QOpcUaConnectionSettings
\inmodule QtOpcUa
\brief The common parameters for a connection to a server.
\since 6.6
This class stores common connection parameters like the session timeout, the
secure channel lifetime and the localeIds.
The information from this class is currently only used by the open62541 backend.
|
6373 |
- |
| qopcuaconnectionsettings.h |
|
2378 |
- |
| qopcuacontentfilterelement.cpp |
!
\class QOpcUaContentFilterElement
\inmodule QtOpcUa
\brief The OPC UA ContentFilterElement.
A content filter element contains an operator and a list of operands.
There are four different operator types which contain literal values, references to
attributes of nodes or to other content filter elements.
A combination of one or more content filter elements makes a content filter which is used
by the server to filter data for the criteria defined by the content filter elements.
For example, the \c where clause of an event filter is a content filter which is used to decide
if a notification is generated for an event.
|
5980 |
- |
| qopcuacontentfilterelement.h |
|
2900 |
- |
| qopcuacontentfilterelementresult.cpp |
!
\class QOpcUaContentFilterElementResult
\inmodule QtOpcUa
\brief The OPC UA ContentFilterElementResult.
QOpcUaContentFilterElementResult contains the status code for a
filter element and all its operands.
|
2598 |
- |
| qopcuacontentfilterelementresult.h |
|
1252 |
- |
| qopcuadatavalue.cpp |
!
\class QOpcUaDataValue
\inmodule QtOpcUa
\brief This class stores OPC UA value data and associated metadata.
\since 6.3
This class corresponds to the OPC UA DataValue type.
|
4912 |
- |
| qopcuadatavalue.h |
|
1885 |
- |
| qopcuadeletereferenceitem.cpp |
!
\class QOpcUaDeleteReferenceItem
\inmodule QtOpcUa
\brief This class stores the necessary information to delete a reference from the server.
\sa QOpcUaClient::deleteReference()
|
3360 |
- |
| qopcuadeletereferenceitem.h |
|
1405 |
- |
| qopcuadiagnosticinfo.cpp |
!
\class QOpcUaDiagnosticInfo
\inmodule QtOpcUa
\since 6.7
\brief The QOpcUaDiagnosticInfo class models the OPC UA built-in type DiagnosticInfo.
The DiagnosticInfo type is used to convey diagnostics for some operations
on the server. The \l qint32 type members refer to an index in the stringTable
field of the OPC UA response header which is currently not supported by
Qt OPC UA.
|
11571 |
- |
| qopcuadiagnosticinfo.h |
|
3572 |
- |
| qopcuadoublecomplexnumber.cpp |
!
\class QOpcUaDoubleComplexNumber
\inmodule QtOpcUa
\brief The OPC UA DoubleComplexNumber type.
The DoubleComplexNumberType defined in OPC UA 1.05 part 8, 5.6.5.
It stores a complex number with double precision.
|
2613 |
- |
| qopcuadoublecomplexnumber.h |
|
1170 |
- |
| qopcuaelementoperand.cpp |
!
\class QOpcUaElementOperand
\inmodule QtOpcUa
\brief The OPC UA ElementOperand type.
The ElementOperand is defined in OPC UA 1.05 part 4, 7.7.4.2.
It is used to identify another element in the filter by its index
(the first element has the index 0).
This is required to create complex filters, for example to reference
the two operands of the AND operation in ((Severity > 500) AND (Message == "TestString")).
The first step is to create content filter elements for the two conditions (Severity > 500)
and (Message == "TestString"). A third content filter element is required to create an AND
combination of the two conditions. It consists of the AND operator and two element operands
with the indices of the two conditions created before:
\code
QOpcUaMonitoringParameters::EventFilter filter;
...
// setup select clauses
...
QOpcUaContentFilterElement condition1;
QOpcUaContentFilterElement condition2;
QOpcUaContentFilterElement condition3;
condition1 << QOpcUaContentFilterElement::FilterOperator::GreaterThan << QOpcUaSimpleAttributeOperand("Severity") <<
QOpcUaLiteralOperand(quint16(500), QOpcUa::Types::UInt16);
condition2 << QOpcUaContentFilterElement::FilterOperator::Equals << QOpcUaSimpleAttributeOperand("Message") <<
QOpcUaLiteralOperand("TestString", QOpcUa::Types::String);
condition3 << QOpcUaContentFilterElement::FilterOperator::And << QOpcUaElementOperand(0) << QOpcUaElementOperand(1);
filter << condition1 << condition2 << condition3;
\endcode
|
3886 |
- |
| qopcuaelementoperand.h |
|
1490 |
- |
| qopcuaendpointdescription.cpp |
!
\class QOpcUaEndpointDescription
\inmodule QtOpcUa
\brief The OPC UA EndpointDescription.
An endpoint description contains information about an endpoint and how to connect to it.
|
8598 |
- |
| qopcuaendpointdescription.h |
|
2557 |
- |
| qopcuaenumdefinition.cpp |
!
\class QOpcUaEnumDefinition
\inmodule QtOpcUa
\since 6.7
\brief The OPC UA EnumDefinition type.
This is the Qt OPC UA representation for the OPC UA EnumDefinition type defined in OPC UA part 3.
It describes an enumerated type.
|
3344 |
- |
| qopcuaenumdefinition.h |
|
1896 |
- |
| qopcuaenumfield.cpp |
!
\class QOpcUaEnumField
\inmodule QtOpcUa
\since 6.7
\brief The OPC UA StructureDefinition type.
This is the Qt OPC UA representation for the OPC UA EnumField type defined in OPC UA part 3.
It describes a field of an enum type.
|
4292 |
- |
| qopcuaenumfield.h |
|
2097 |
- |
| qopcuaerrorstate.cpp |
!
\class QOpcUaErrorState
\inmodule QtOpcUa
\since QtOpcUa 5.13
\brief QOpcUaErrorState allows investigation and interaction with error state from backends.
There is not need to instantiate this class in your code.
A client will emit an error state via \l QOpcUaClient::connectError in case an error has happened
while establishing a connection.
The error can be caused by the backend itself or by the server rejecting the connection.
If case of errors issued by the local backend, they can be ignored by calling the function
\l setIgnoreError().
|
3665 |
- |
| qopcuaerrorstate.h |
|
1282 |
- |
| qopcuaeuinformation.cpp |
!
\class QOpcUaEUInformation
\inmodule QtOpcUa
\brief The OPC UA EURange type.
This is the Qt OPC UA representation for the OPC UA EUInformation type defined in OPC UA 1.05 part 8, 5.6.3.
EUInformation values contain information about units and are mostly used as property of a node with a numeric value attribute.
The information can e. g. be used to add text and tooltips to GUI elements.
|
3896 |
- |
| qopcuaeuinformation.h |
|
1466 |
- |
| qopcuaeventfilterresult.cpp |
!
\class QOpcUaEventFilterResult
\inmodule QtOpcUa
\brief The OPCUA EventFilterResult.
The EventFilterResult contains status codes for all elements of the \c select clauses
and all elements of the \c where clause.
|
3497 |
- |
| qopcuaeventfilterresult.h |
|
1344 |
- |
| qopcuaexpandednodeid.cpp |
!
\class QOpcUaExpandedNodeId
\inmodule QtOpcUa
\brief The OPC UA ExpandedNodeId.
An expanded node id is a node id where the namespace index can be given as index or as a string URI.
A list of namespaces and their indices on the server is provided by \l QOpcUaClient::namespaceArray().
|
3836 |
- |
| qopcuaexpandednodeid.h |
|
1300 |
- |
| qopcuaextensionobject.cpp |
!
\class QOpcUaExtensionObject
\inmodule QtOpcUa
\brief The OPC UA ExtensionObject.
This is the Qt OPC UA representation for an extension object.
Extension objects are used as a container in OPC UA whenever a non-builtin type is stored
in a Variant. It contains information about the type and encoding of the data as well as
the data itself encoded with one of the encodings specified in OPC UA part 6.
Decoders are supposed to decode extension objects if they can handle the type. If the type
is not supported by the decoder, the extension object is not decoded and decoding is left
to the user.
|
5118 |
- |
| qopcuaextensionobject.h |
|
1623 |
- |
| qopcuagdsclient.cpp |
!
\class QOpcUaGdsClient
\inmodule QtOpcUa
\since 5.14
\brief Handles communication with the GDS Server.
This class is currently available as a Technology Preview, and therefore the API
and functionality provided by the class may be subject to change at any time without
prior notice.
This class handles all steps needed for communication with a GDS server. Provided with
information about the application it does registering with the server and managing
key/certificates.
Only few details need to be known in order to take part in a secured network.
First time registration requires administrative privileges using username and password
for authentication. All further authentications are application based, using the certificate
which was received first.
Expecting the whole process to succeed, you have to wait for the applicationRegistered signal.
Most of the setup structs have to be the same as for the connection with QOpcUaClient afterwards
and can be shared.
Setting up a GDS client:
\code
QOpcUaGdsClient c;
// In case the credentials are needed
QObject::connect(&c, &QOpcUaGdsClient::authenticationRequired, [&](QOpcUaAuthenticationInformation &authInfo) {
authInfo.setUsernameAuthentication("root", "secret");
});
// Await success
QObject::connect(&c, &QOpcUaGdsClient::applicationRegistered, [&]() {
qDebug() << "Application" << c.applicationId() << "registered";
});
c.setBackend(...);
c.setEndpoint(...);
c.setApplicationIdentity(...);
c.setPkiConfiguration(...);
c.setApplicationRecord(...);
c.setCertificateSigningRequestPresets(...);
c.start();
\endcode
|
64025 |
- |
| qopcuagdsclient.h |
|
3093 |
- |
| qopcuagdsclient_p.h |
|
5330 |
- |
| qopcuagenericstructhandler.cpp |
!
\class QOpcUaGenericStructHandler
\inmodule QtOpcUa
\since 6.7
\brief Reads a server's data types and decodes/encodes generic structs from/to extension objects.
The binary data encoding used in OPC UA was designed with a small message size in mind and doesn't
contain any information about the structure of the data.
This means that a decoder must known the structure of the encoded data in advance to be able to
decode a data buffer.
Since OPC UA 1.04, nodes of the DataType node class may have the DataTypeDefinition attribute
which contain information about the fields of structured types and the mapping of enum values
to names. Together with the knowledge about how to decode built-in types, this allows a client to
decode generic custom structured types without relying on outside knowledge.
QOpcUaGenericStructHandler traverses the type hierarchy of a server by following the HasSubtype
references starting from BaseDataType and reads the DataTypeDefinition attribute of the nodes.
For structured types where a \l QOpcUaStructureDefinition value is present in the DataTypeDefinition
attribute, automatic decoding of extension objects containing them is available. Fields with a built-in
type or a type where a C++ data class exists are deserialized to the corresponding Qt OPC UA type,
other generic structs are serialized to a nested \l QOpcUaGenericStructValue.
All nested generic struct values must have a \l QOpcUaStructureDefinition in the server or decoding fails.
The same conditions apply to encoding a custom struct.
Example for decoding a custom struct:
\code
QOpcUaGenericStructHandler handler(opcuaClient);
handler.initialize();
QObject::connect(&handler, &QOpcUaGenericStructHandler::initializedChanged, [opcuaClient, &handler](bool initialized) {
if (!initialized)
return;
auto node = opcuaClient->node("ns=4;i=3003"); // A custom struct test node in the open62541-testserver
node->readValueAttribute();
QObject::connect(node, &QOpcUaNode::attributeRead, [node, &handler](QOpcUa::NodeAttributes attr) {
if (!attr.testFlag(QOpcUa::NodeAttribute::Value) || node->valueAttributeError() != QOpcUa::UaStatusCode::Good)
return;
auto extObj = node->valueAttribute().value<QOpcUaExtensionObject>();
qDebug() << "Got object of type" << handler.typeNameForBinaryEncodingId(extObj.encodingTypeId());
const auto result = handler.decode(extObj);
if (!result)
return;
qDebug() << *result;
});
});
\endcode
Example for encoding a custom struct:
\code
QOpcUaGenericStructHandler handler(opcuaClient);
handler.initialize();
QObject::connect(&handler, &QOpcUaGenericStructHandler::initializedChanged, [opcuaClient, &handler](bool initialized) {
if (!initialized)
return;
QOpcUaGenericStructValue value = handler.createGenericStructValueForTypeId("ns=4;i=3006");
value.fieldsRef()["MandatoryMember"] = 23.0;
value.fieldsRef()["OptionalMember"] = 42.0;
const auto ext = handler.encode(value);
if (!ext)
return;
// Use the extension object to write a node's value attribute, in a method parameter, etc...
});
\endcode
|
10348 |
- |
| qopcuagenericstructhandler.h |
|
2565 |
- |
| qopcuagenericstructhandler_p.h |
|
7078 |
- |
| qopcuagenericstructhandlerprivate.cpp |
|
42664 |
- |
| qopcuagenericstructvalue.cpp |
!
\class QOpcUaGenericStructValue
\inmodule QtOpcUa
\since 6.7
\brief Holds the value of a generic OPC UA structured type.
This class holds a generic OPC UA struct value which consists of named fields with their values
which can be built-in types or their sub types as well as other nested generic structs.
Some meta information like the type ID and the structure definition of the type contained in
an object of this class is also included.
It is used as return type for the decoding result and as input type for the encoding method of
\l QOpcUaGenericStructHandler.
For a struct with optional fields, only the fields that were specified are contained in the
\a fields() list. To omit an optional field during encoding, it must not appear in the fields()
list.
For structs derived from the Union type, only one of the fields must be specified.
The only entry in the fields() list of a decoded type determines which field (if any) of the
type definition was specified.
Example:
\code
// Decode an extension object
QOpcUaGenericStructValue value = decoder.decode(extensionObject, success);
// Print the value of a mandatory field
qDebug() << value.fields().value("MyField").value<QOpcUaLocalizedText>();
// Print the value of an optional field
if (value.fields().contains("MyOptionalField"))
qDebug() << value.fields().value("MyField").value<QOpcUaQualifiedName>();
// Get a nested struct for a field
const auto unionMember = value.fields().value("MyUnionMember").value<QOpcUaGenericStructValue>();
// Print the specified field
if (unionMember.fields().contains("UnionMember1"))
qDebug() << unionMember.fields().value("UnionMember1").toInt();
else if (unionMember.fields().contains("UnionMember2"))
qDebug() << unionMember.fields().value("UnionMember2").toDouble();
else
qDebug() << "Empty union";
\endcode
|
9439 |
- |
| qopcuagenericstructvalue.h |
|
3088 |
- |
| qopcuahistorydata.cpp |
!
\class QOpcUaHistoryData
\inmodule QtOpcUa
\brief This class stores historical data values from a node.
\since 6.3
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.
|
3183 |
- |
| qopcuahistorydata.h |
|
1256 |
- |
| qopcuahistoryevent.cpp |
!
\class QOpcUaHistoryEvent
\inmodule QtOpcUa
\brief This class stores historical events from a node.
\since 6.7
When a request to read history events is being handled, instances of this class
are used to store information about which node has been read, its events and
the status code.
The finished signal of a history read response will return a list of QOpcUaHistoryEvent
objects which can be parsed to review the results of the request.
|
4624 |
- |
| qopcuahistoryevent.h |
|
2137 |
- |
| qopcuahistoryreadeventrequest.cpp |
!
\class QOpcUaHistoryReadEventRequest
\inmodule QtOpcUa
\brief This class stores the necessary information to request historic data from a server.
\since 6.7
This is the Qt OPC UA representation for the OPC UA ReadEventDetails for reading historical data
defined in \l {https://reference.opcfoundation.org/Core/docs/Part11/6.4.2/} {OPC-UA part 11, 6.4.2}.
When requesting historic data from a server, several values need to be provided to the server
to know which data to collect. The QOpcUaHistoryReadEventRequest class provides the required values.
\a startTimestamp and \a endTimestamp define the timerange where historic events should be collected from.
\a nodesToRead defines from which nodes historic data should be collected.
\a numValuesPerNode defines the maximum number of events that should be returned per node.
\a filter is the event filter used to determine which events and which of their fields to return.
|
7826 |
- |
| qopcuahistoryreadeventrequest.h |
|
3192 |
- |
| qopcuahistoryreadrawrequest.cpp |
!
\class QOpcUaHistoryReadRawRequest
\inmodule QtOpcUa
\brief This class stores the necessary information to request historic data from a server.
\since 6.3
This is the Qt OPC UA representation for the OPC UA ReadRawModifiedDetails for reading historical data
defined in \l {https://reference.opcfoundation.org/Core/Part11/v104/docs/6.4.3} {OPC UA 1.04 part 11, 6.4.3}.
When requesting historic data from a server, several values need to be provided to the server
to know which data to collect. The QOpcUaHistoryReadRawRequest class provides the required values.
\a startTimestamp and \a endTimestamp define the timerange where historic data should be collected from.
\a nodesToRead defines from which nodes historic data should be collected.
\a numValuesPerNode defines the maximum number of data values that should be returned per node.
\a returnBounds defines if the bounding values should be included in the result.
|
7992 |
- |
| qopcuahistoryreadrawrequest.h |
|
2890 |
- |
| qopcuahistoryreadresponse.cpp |
!
\class QOpcUaHistoryReadResponse
\inmodule QtOpcUa
\brief This class is used for requesting historical data and storing the results.
\since 6.3
A historical data request to an OPC UA server can be specified by a \l QOpcUaHistoryReadRawRequest
or \l QOpcUaHistoryReadEventRequest.
Objects of this class and the statuscode of the request are returned in the
\l QOpcUaHistoryReadResponse::readHistoryDataFinished(const QList<QOpcUaHistoryData> &results, QOpcUa::UaStatusCode serviceResult)
or \l QOpcUaHistoryReadResponse::readHistoryEventsFinished(const QList<QOpcUaHistoryEvent> &results, QOpcUa::UaStatusCode serviceResult)
signal depending on the request type and contain the result of a request.
|
4058 |
- |
| qopcuahistoryreadresponse.h |
|
1569 |
- |
| qopcuahistoryreadresponse_p.h |
|
2148 |
- |
| qopcuahistoryreadresponseimpl.cpp |
|
8193 |
- |
| qopcuahistoryreadresponseimpl_p.h |
|
3455 |
- |
| qopcuainternaldatatypenode.cpp |
|
3762 |
- |
| qopcuainternaldatatypenode_p.h |
|
1534 |
- |
| qopcualiteraloperand.cpp |
!
\class QOpcUaLiteralOperand
\inmodule QtOpcUa
\brief The OPC UA LiteralOperand type.
The LiteralOperand is defined in OPC UA 1.05 part 4, 7.7.4.3.
It contains a literal value that is to be used as operand.
|
2974 |
- |
| qopcualiteraloperand.h |
|
1594 |
- |
| qopcualocalizedtext.cpp |
!
\class QOpcUaLocalizedText
\inmodule QtOpcUa
\brief The OPC UA LocalizedText type.
This is the Qt OPC UA representation for the OPC UA LocalizedText type defined in OPC UA 1.05 part 3, 8.5.
A LocalizedText value contains a text string with associated locale information in a second string (e. g. "en" or "en-US").
The format of the locale information string is <language>[-<country/region>]. Language is usually given as ISO 639 two letter code,
country/region as ISO 3166 two letter code. Custom codes are also allowed (see OPC UA 1.05 part 3, 8.4).
It can be used to provide multiple text strings in different languages for a value using an array of LocalizedText elements.
|
4079 |
- |
| qopcualocalizedtext.h |
|
1380 |
- |
| qopcuamonitoringparameters.cpp |
!
\class QOpcUaMonitoringParameters
\inmodule QtOpcUa
\brief QOpcUaMonitoringParameters provides a way to set and retrieve parameters for subscriptions and monitored items.
This class is used in \l QOpcUaNode::enableMonitoring() requests
and as return value for \l QOpcUaNode::monitoringStatus() in which case it contains
the revised values from the server.
\section1 Usage
For most use cases, only the publishing interval is required.
\code
QOpcUaMonitoringParameters p(100); // Set a publishing interval of 100ms and share the subscription.
node->enableMonitoring(QOpcUa::NodeAttribute::Value, p);
\endcode
If an \l {QOpcUaMonitoringParameters::SubscriptionType} {exclusive} subscription is required, use the second parameter.
\code
QOpcUaMonitoringParameters p(100, QOpcUaMonitoringParameters::SubscriptionType::Exclusive); // Create a new subscription
\endcode
To add additional items to an existing subscription, use the third parameter for the next calls to QOpcUaNode::enableMonitoring().
\code
quint32 subscriptionId = node->monitoringStatus(QOpcUa::NodeAttribute::Value).subscriptionId();
QOpcUaMonitoringParameters p(100, QOpcUaMonitoringParameters::SubscriptionType::Shared, subscriptionId); // Add the monitored item to this subscription
\endcode
If other parameters are required, they must be set using the setter methods.
|
24422 |
- |
| qopcuamonitoringparameters.h |
|
7054 |
- |
| qopcuamonitoringparameters_p.h |
|
2312 |
- |
| qopcuamultidimensionalarray.cpp |
This class has been modelled in the style of the Variant encoding
defined in OPC UA 1.05 part 6, 5.2.2.16.
This solution has been preferred to returning nested QVariantLists
due to the following reasons:
- A QVariantList inside a QVariantList is stored as a QVariant which must be converted
to QVariantList before the elements can be accessed. This makes it impossible to update the
values in place.
- The length of the array is encoded as a 32 bit unsigned integer.
Array dimensions are encoded in an array, so an array can have UINT32_MAX dimensions.
Depending on the number of dimensions, there could be lots of nested QVariantLists
which would require a huge effort when calculating the array dimensions for conversions
between QVariantList and the sdk specific variant type.
|
7711 |
- |
| qopcuamultidimensionalarray.h |
|
1678 |
- |
| qopcuanode.cpp |
|
37296 |
- |
| qopcuanode.h |
|
6156 |
- |
| qopcuanode_p.h |
|
9707 |
- |
| qopcuanodecreationattributes.cpp |
!
\class QOpcUaNodeCreationAttributes
\inmodule QtOpcUa
\brief This class manages attribute values for node creation.
This class holds values for node attributes that are passed to the server
when creating a new node in the OPC UA address space.
The following node attributes are supported by the different node classes:
\table
\header
\li Attribute
\li Object
\li Variable
\li Method
\li ObjectType
\li VariableType
\li ReferenceType
\li DataType
\li View
\row
\li AccessLevel
\li
\li X
\li
\li
\li
\li
\li
\li
\row
\li ArrayDimensions
\li
\li X
\li
\li
\li X
\li
\li
\li
\row
\li ContainsNoLoops
\li
\li
\li
\li
\li
\li
\li
\li X
\row
\li DataType
\li
\li X
\li
\li
\li X
\li
\li
\li
\row
\li Description
\li X
\li X
\li X
\li X
\li X
\li X
\li X
\li X
\row
\li DisplayName
\li X
\li X
\li X
\li X
\li X
\li X
\li X
\li X
\row
\li EventNotifier
\li X
\li
\li
\li
\li
\li
\li
\li
\row
\li Executable
\li
\li
\li X
\li
\li
\li
\li
\li
\row
\li Historizing
\li
\li X
\li
\li
\li
\li
\li
\li
\row
\li InverseName
\li
\li
\li
\li
\li
\li X
\li
\li
\row
\li IsAbstract
\li
\li
\li
\li X
\li X
\li X
\li X
\li
\row
\li MinimumSamplingInterval
\li
\li X
\li
\li
\li
\li
\li
\li
\row
\li Symmetric
\li
\li
\li
\li
\li
\li X
\li
\li
\row
\li UserAccessLevel
\li
\li X
\li
\li
\li
\li
\li
\li
\row
\li UserExecutable
\li
\li
\li X
\li
\li
\li
\li
\li
\row
\li UserWriteMask
\li X
\li X
\li X
\li X
\li X
\li X
\li X
\li X
\row
\li Value
\li
\li X
\li
\li
\li X
\li
\li
\li
\row
\li ValueRank
\li
\li X
\li
\li
\li X
\li
\li
\li
\row
\li WriteMask
\li X
\li X
\li X
\li X
\li X
\li X
\li X
\li X
\endtable
\sa QOpcUaClient::addNode()
|
16691 |
- |
| qopcuanodecreationattributes.h |
|
3449 |
- |
| qopcuanodecreationattributes_p.h |
|
2792 |
- |
| qopcuanodeids.cpp |
!
\namespace QOpcUa::NodeIds
\inmodule QtOpcUa
\inheaderfile QtOpcUa/qopcuanodeids.h
\brief This namespace contains enums with known node ids.
|
1669067 |
- |
| qopcuanodeids.h |
|
1870338 |
- |
| qopcuanodeidsmetaobject.cpp |
|
2022354 |
- |
| qopcuanodeimpl.cpp |
|
707 |
- |
| qopcuanodeimpl_p.h |
|
3940 |
- |
| qopcuapkiconfiguration.cpp |
!
\class QOpcUaPkiConfiguration
\inmodule QtOpcUa
\brief QOpcUaPkiConfiguration defines the PKI configuration of the application.
\since QtOpcUa 5.13
This info must be configured using QOpcUaClient::setPkiConfiguration.
The used paths and files must be created beforehand.
\code
QOpcUaPkiConfiguration pkiConfig;
const QString pkiDir = QCoreApplication::applicationDirPath() + "/pki";
pkiConfig.setClientCertificateFile(pkiDir + "/own/certs/application.der");
pkiConfig.setPrivateKeyFile(pkiDir + "/own/private/application.pem");
pkiConfig.setTrustListDirectory(pkiDir + "/trusted/certs");
pkiConfig.setRevocationListDirectory(pkiDir + "/trusted/crl");
pkiConfig.setIssuerListDirectory(pkiDir + "/issuers/certs");
pkiConfig.setIssuerRevocationListDirectory(pkiDir + "/issuers/crl");
client->setPkiConfiguration(pkiConfig);
\endcode
|
7562 |
- |
| qopcuapkiconfiguration.h |
|
1692 |
- |
| qopcuaqualifiedname.cpp |
!
\class QOpcUaQualifiedName
\inmodule QtOpcUa
\brief The OPC UA QualifiedName type.
This is the Qt OPC UA representation for the OPC UA QualifiedName type defined in OPC UA 1.05 part 3, 8.3.
A QualifiedName is a name qualified by a namespace index. The namespace index corresponds to an entry in the server's namespace array.
QualifiedName is mainly used to represent the BrowseName attribute of a node.
|
3201 |
- |
| qopcuaqualifiedname.h |
|
1257 |
- |
| qopcuarange.cpp |
!
\class QOpcUaRange
\inmodule QtOpcUa
\brief The OPC UA Range type.
This is the Qt OPC UA representation for the OPC UA Range type defined in OPC UA 1.05 part 8, 5.6.2.
It consists of two double values which mark minimum and maximum of the range.
Ranges are mostly used to store information about acceptable values for a node.
|
2202 |
- |
| qopcuarange.h |
|
936 |
- |
| qopcuareaditem.cpp |
!
\class QOpcUaReadItem
\inmodule QtOpcUa
\brief This class stores the options for a read operation.
A read operation on an OPC UA server returns the entire value or a certain index range of the value of an
attribute of a node on the server. This class contains the necessary information for the backend to make
a read request to the server.
One or multiple objects of this class make up the request of a \l QOpcUaClient::readNodeAttributes() operation.
\sa QOpcUaClient::readNodeAttributes() QOpcUaReadResult
|
3485 |
- |
| qopcuareaditem.h |
|
1422 |
- |
| qopcuareadresult.cpp |
!
\class QOpcUaReadResult
\inmodule QtOpcUa
\brief This class stores the result of a read operation.
A read operation on an OPC UA server returns the value and timestamps which describe when a value was generated
by the source and when the server obtained it. It also returns a status code which describes if the value could
be read and if not, for what reason the read has failed.
In addition to the data returned by the server, this class also contains the node id, the attribute and the index
range from the request to enable a client to match the result with a request.
Objects of this class are returned in the \l QOpcUaClient::readNodeAttributesFinished()
signal and contain the result of a read operation that was part of a \l QOpcUaClient::readNodeAttributes()
request.
\sa QOpcUaClient::readNodeAttributes() QOpcUaClient::readNodeAttributesFinished() QOpcUaReadItem
|
4171 |
- |
| qopcuareadresult.h |
|
1379 |
- |
| qopcuareferencedescription.cpp |
!
\class QOpcUaReferenceDescription
\inmodule QtOpcUa
\brief Contains information about a node.
This class is used to return the results of a call to \l QOpcUaNode::browse() or
\l QOpcUaNode::browseChildren().
It contains the type and direction of the reference used to connect the node
to the starting node of the browse operation, the node id of the target's type
definition node and the values of the following \l {QOpcUa::NodeAttribute} {node attributes}:
\table
\header
\li Attribute
\row
\li NodeId
\row
\li BrowseName
\row
\li DisplayName
\row
\li NodeClass
\endtable
|
4577 |
- |
| qopcuareferencedescription.h |
|
1752 |
- |
| qopcuarelativepathelement.cpp |
!
\class QOpcUaRelativePathElement
\inmodule QtOpcUa
\brief The OPC UA RelativePathElement.
QOpcUaRelativePathElement defines an element of a relative path on an OPC UA server.
This is needed for resolution of browse paths to node ids in \l QOpcUaNode::resolveBrowsePath().
|
5137 |
- |
| qopcuarelativepathelement.h |
|
2187 |
- |
| qopcuasecuritypolicyuris_p.h |
|
1367 |
- |
| qopcuasimpleattributeoperand.cpp |
!
\class QOpcUaSimpleAttributeOperand
\inmodule QtOpcUa
\brief The OPC UA SimpleAttributeOperand type.
The SimpleAttributeOperand is specified in OPC UA 1.05 part 4, 7.7.4.5.
It is used when a node attribute is required as operand.
For example, the following simple attribute operand represents the value
of the "Severity" field of the base event type:
\code
QOpcUaSimpleAttributeOperand("Severity");
\endcode
|
5614 |
- |
| qopcuasimpleattributeoperand.h |
|
2550 |
- |
| qopcuastructuredefinition.cpp |
!
\class QOpcUaStructureDefinition
\inmodule QtOpcUa
\since 6.7
\brief The OPC UA StructureDefinition type.
This is the Qt OPC UA representation for the OPC UA StructureDefinition type defined in OPC UA part 3.
It describes the structure of a structured type.
|
5373 |
- |
| qopcuastructuredefinition.h |
|
2640 |
- |
| qopcuastructurefield.cpp |
!
\class QOpcUaStructureField
\inmodule QtOpcUa
\since 6.7
\brief The OPC UA StructureField type.
This is the Qt OPC UA representation for the OPC UA StructureField type defined in OPC UA part 3.
It describes a field of a structured type.
|
6302 |
- |
| qopcuastructurefield.h |
|
2680 |
- |
| qopcuatype.cpp |
!
\namespace QOpcUa
\inmodule QtOpcua
\brief The QOpcUa namespace contains miscellaneous identifiers used throughout the Qt OPC UA library.
|
57348 |
- |
| qopcuatype.h |
|
22226 |
- |
| qopcuausertokenpolicy.cpp |
!
\class QOpcUaUserTokenPolicy
\inmodule QtOpcUa
\brief The OPC UA UserTokenPolicy.
The user token policy contains information about an user token accepted by the server.
|
4807 |
- |
| qopcuausertokenpolicy.h |
|
1551 |
- |
| qopcuavariant.cpp |
!
\class QOpcUaVariant
\inmodule QtOpcUa
\since 6.7
\brief The OPC UA Variant.
The OPC UA variant is an union of all built-in OPC UA types and also contains
information about the array dimensions associated with the value.
This class is currently only supported by \l QOpcUaBinaryDataEncoding and
\l QOpcUaGenericStructHandler.
|
6997 |
- |
| qopcuavariant.h |
|
2903 |
- |
| qopcuawriteitem.cpp |
!
\class QOpcUaWriteItem
\inmodule QtOpcUa
\brief This class stores the options for a write operation.
A write operation on an OPC UA server overwrites the entire value or a certain index range of the value of an
attribute of a node on the server. This class contains the necessary information for the backend to make
a write request to the server.
One or multiple objects of this class make up the request of a \l QOpcUaClient::writeNodeAttributes() operation.
\sa QOpcUaClient::writeNodeAttributes() QOpcUaWriteResult
|
5939 |
- |
| qopcuawriteitem.h |
|
1737 |
- |
| qopcuawriteresult.cpp |
!
\class QOpcUaWriteResult
\inmodule QtOpcUa
\brief This class stores the result of a write operation.
A write operation on an OPC UA server returns a status code which describes if the value could
be written and if not, for what reason the write has failed.
In addition to the status code returned by the server, this class also contains the node id, the attribute and the index
range from the request to enable a client to match the result with a request.
Objects of this class are returned in the \l QOpcUaClient::writeNodeAttributesFinished()
signal and contain the result of a write operation that was part of a \l QOpcUaClient::writeNodeAttributes()
request.
\sa QOpcUaClient::writeNodeAttributes() QOpcUaClient::writeNodeAttributesFinished() QOpcUaWriteItem
|
3140 |
- |
| qopcuawriteresult.h |
|
1117 |
- |
| qopcuaxvalue.cpp |
!
\class QOpcUaXValue
\inmodule QtOpcUa
\brief The OPC UA XVType.
This is the Qt OPC UA representation for the OPC UA XVType type defined in OPC UA 1.05 part 8, 5.6.8.
This type is used to position values of float precision on an axis with double precision.
|
2196 |
- |
| qopcuaxvalue.h |
|
944 |
- |