QOpcUaApplicationDescription Class
The OPC UA ApplicationDescription. More...
| Header: | #include <QOpcUaApplicationDescription> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS OpcUa)target_link_libraries(mytarget PRIVATE Qt6::OpcUa) |
| qmake: | QT += opcua |
Public Types
| enum | ApplicationType { Server, Client, ClientAndServer, DiscoveryServer } |
Properties
|
|
Public Functions
| QOpcUaApplicationDescription() | |
| QOpcUaApplicationDescription(const QOpcUaApplicationDescription &other) | |
| QOpcUaLocalizedText | applicationName() const |
| QOpcUaApplicationDescription::ApplicationType | applicationType() const |
| QString | applicationUri() const |
| QString | discoveryProfileUri() const |
| QList<QString> | discoveryUrls() const |
| QList<QString> & | discoveryUrlsRef() |
| QString | gatewayServerUri() const |
| QString | productUri() const |
| void | setApplicationName(const QOpcUaLocalizedText &applicationName) |
| void | setApplicationType(QOpcUaApplicationDescription::ApplicationType applicationType) |
| void | setApplicationUri(const QString &applicationUri) |
| void | setDiscoveryProfileUri(const QString &discoveryProfileUri) |
| void | setDiscoveryUrls(const QList<QString> &discoveryUrls) |
| void | setGatewayServerUri(const QString &gatewayServerUri) |
| void | setProductUri(const QString &productUri) |
| QOpcUaApplicationDescription & | operator=(const QOpcUaApplicationDescription &other) |
| bool | operator==(const QOpcUaApplicationDescription &rhs) const |
Detailed Description
The application description contains information about an OPC UA application.
Member Type Documentation
enum QOpcUaApplicationDescription::ApplicationType
This enum type holds the application type.
| Constant | Value | Description |
|---|---|---|
QOpcUaApplicationDescription::Server | 0 | This application is a server. |
QOpcUaApplicationDescription::Client | 1 | This application is a client. |
QOpcUaApplicationDescription::ClientAndServer | 2 | This application is a client and a server. |
QOpcUaApplicationDescription::DiscoveryServer | 3 | This application is a discovery server. |
Property Documentation
[read-only] applicationName : const QOpcUaLocalizedText
Name describing the application.
Access functions:
| QOpcUaLocalizedText | applicationName() const |
[read-only] applicationType : const QOpcUaApplicationDescription::ApplicationType
The application's type: server, client, both, or discovery server.
Access functions:
| QOpcUaApplicationDescription::ApplicationType | applicationType() const |
[read-only] applicationUri : const QString
The globally unique identifier for this application instance.
Access functions:
| QString | applicationUri() const |
[read-only] discoveryProfileUri : const QString
The URI of the supported discovery profile.
Access functions:
| QString | discoveryProfileUri() const |
[read-only] discoveryUrls : const QList<QString>
A list of URLs of discovery endpoints.
Access functions:
| QList<QString> | discoveryUrls() const |
[read-only] gatewayServerUri : const QString
The URI of the gateway server.
Access functions:
| QString | gatewayServerUri() const |
[read-only] productUri : const QString
The globally unique identifier for this product.
Access functions:
| QString | productUri() const |
Member Function Documentation
QOpcUaApplicationDescription::QOpcUaApplicationDescription()
Default constructs an application description with no parameters set.
QOpcUaApplicationDescription::QOpcUaApplicationDescription(const QOpcUaApplicationDescription &other)
Constructs an application description from other.
QOpcUaLocalizedText QOpcUaApplicationDescription::applicationName() const
Returns a name describing the application.
Note: Getter function for property applicationName.
See also setApplicationName().
QOpcUaApplicationDescription::ApplicationType QOpcUaApplicationDescription::applicationType() const
Returns the application's type (server, client, both, discovery server).
Note: Getter function for property applicationType.
See also setApplicationType().
QString QOpcUaApplicationDescription::applicationUri() const
Returns the globally unique identifier for this application instance.
Note: Getter function for property applicationUri.
See also setApplicationUri().
QString QOpcUaApplicationDescription::discoveryProfileUri() const
Returns the URI of the supported discovery profile.
Note: Getter function for property discoveryProfileUri.
See also setDiscoveryProfileUri().
QList<QString> QOpcUaApplicationDescription::discoveryUrls() const
Returns a list of URLs of discovery endpoints.
Note: Getter function for property discoveryUrls.
See also setDiscoveryUrls().
QList<QString> &QOpcUaApplicationDescription::discoveryUrlsRef()
Returns a reference to a list of URLs of discovery endpoints.
QString QOpcUaApplicationDescription::gatewayServerUri() const
Returns the URI of the gateway server.
Note: Getter function for property gatewayServerUri.
See also setGatewayServerUri().
QString QOpcUaApplicationDescription::productUri() const
Returns the globally unique identifier for this product.
Note: Getter function for property productUri.
See also setProductUri().
void QOpcUaApplicationDescription::setApplicationName(const QOpcUaLocalizedText &applicationName)
Sets the application name to applicationName.
See also applicationName().
void QOpcUaApplicationDescription::setApplicationType(QOpcUaApplicationDescription::ApplicationType applicationType)
Sets the application type to applicationType.
See also applicationType().
void QOpcUaApplicationDescription::setApplicationUri(const QString &applicationUri)
Sets the globally unique identifier for this application instance to applicationUri.
See also applicationUri().
void QOpcUaApplicationDescription::setDiscoveryProfileUri(const QString &discoveryProfileUri)
Sets the discovery profile URI to discoveryProfileUri.
See also discoveryProfileUri().
void QOpcUaApplicationDescription::setDiscoveryUrls(const QList<QString> &discoveryUrls)
Sets the discovery URLs to discoveryUrls.
See also discoveryUrls().
void QOpcUaApplicationDescription::setGatewayServerUri(const QString &gatewayServerUri)
Sets the URI of the gateway server to gatewayServerUri.
See also gatewayServerUri().
void QOpcUaApplicationDescription::setProductUri(const QString &productUri)
Sets the globally unique identifier for this product to productUri.
See also productUri().
QOpcUaApplicationDescription &QOpcUaApplicationDescription::operator=(const QOpcUaApplicationDescription &other)
Sets the values from other in this application description.
bool QOpcUaApplicationDescription::operator==(const QOpcUaApplicationDescription &rhs) const
Returns true if this application description has the same value as rhs.