C++ Based OPC UA Client/Server SDK
1.6.0.389
|
Wrapper class for the UA stack structure OpcUa_ApplicationDescription. More...
#include <uaapplicationdescription.h>
Public Member Functions | |
UaApplicationDescription () | |
Constructs an instance of the class UaApplicationDescription with empty default values. | |
UaApplicationDescription (const UaApplicationDescription &other) | |
Constructs an instance of the class UaApplicationDescription with values from another UaApplicationDescription object. More... | |
UaApplicationDescription (const OpcUa_ApplicationDescription &other) | |
Constructs an instance of the class UaApplicationDescription with values from another OpcUa_ApplicationDescription structure. More... | |
UaApplicationDescription (const UaString &applicationUri, const UaString &productUri, const UaLocalizedText &applicationName, OpcUa_ApplicationType applicationType, const UaString &gatewayServerUri, const UaString &discoveryProfileUri, const UaStringArray &discoveryUrls) | |
Constructs an instance of the class UaApplicationDescription with values provided in the constructor. | |
UaApplicationDescription (const UaExtensionObject &extensionObject) | |
Constructs an instance of the class UaApplicationDescription initialized with value from a UaExtensionObject. More... | |
UaApplicationDescription (const OpcUa_ExtensionObject &extensionObject) | |
Constructs an instance of the class UaApplicationDescription initialized with value from an OpcUa_ExtensionObject structure. More... | |
~UaApplicationDescription () | |
Destroys the UaApplicationDescription object. | |
void | clear () |
Clear the data of the UaApplicationDescription. More... | |
bool | operator== (const UaApplicationDescription &other) const |
Compare two UaApplicationDescription for equality. More... | |
bool | operator!= (const UaApplicationDescription &other) const |
Compare two UaApplicationDescription for inequality. More... | |
UaApplicationDescription & | operator= (const UaApplicationDescription &other) |
Assignment operator. More... | |
OpcUa_ApplicationDescription * | copy () const |
Copy UaApplicationDescription data to a newly allocated OpcUa_ApplicationDescription. More... | |
void | copyTo (OpcUa_ApplicationDescription *pDst) const |
Copy UaApplicationDescription data to an existing OpcUa_ApplicationDescription structure. More... | |
void | attach (OpcUa_ApplicationDescription *pValue) |
Attaches to an existing OpcUa_ApplicationDescription structure. More... | |
OpcUa_ApplicationDescription * | detach (OpcUa_ApplicationDescription *pDst) |
Detaches the internal ApplicationDescription structure from this class. More... | |
UaString | getApplicationUri () const |
The globally unique identifier for the application instance. More... | |
UaString | getProductUri () const |
The globally unique identifier for the product. | |
UaLocalizedText | getApplicationName () const |
A localized descriptive name for the application. | |
OpcUa_ApplicationType | getApplicationType () const |
The type of application. More... | |
UaString | getGatewayServerUri () const |
A URI that identifies the Gateway Server associated with the DiscoveryUrls. More... | |
UaString | getDiscoveryProfileUri () const |
A URI that identifies the discovery profile supported by the URLs provided. More... | |
void | getDiscoveryUrls (UaStringArray &discoveryUrls) const |
A list of URLs for the discovery Endpoints provided by the application. More... | |
void | setApplicationUri (const UaString &applicationUri) |
The globally unique identifier for the application instance. More... | |
void | setProductUri (const UaString &productUri) |
The globally unique identifier for the product. | |
void | setApplicationName (const UaLocalizedText &applicationName) |
A localized descriptive name for the application. | |
void | setApplicationType (OpcUa_ApplicationType applicationType) |
The type of application. More... | |
void | setGatewayServerUri (const UaString &gatewayServerUri) |
A URI that identifies the Gateway Server associated with the DiscoveryUrls. More... | |
void | setDiscoveryProfileUri (const UaString &discoveryProfileUri) |
A URI that identifies the discovery profile supported by the URLs provided. More... | |
void | setDiscoveryUrls (const UaStringArray &discoveryUrls) |
A list of URLs for the discovery Endpoints provided by the application. More... | |
Static Public Member Functions | |
static OpcUa_ApplicationDescription * | clone (const OpcUa_ApplicationDescription &source) |
Copy OpcUa_ApplicationDescription data to a newly allocated OpcUa_ApplicationDescription. More... | |
static void | cloneTo (const OpcUa_ApplicationDescription &source, OpcUa_ApplicationDescription ©) |
Copy OpcUa_ApplicationDescription data to an existing OpcUa_ApplicationDescription structure. More... | |
Wrapper class for the UA stack structure OpcUa_ApplicationDescription.
This class encapsulates the native OpcUa_ApplicationDescription structure and handles memory allocation and cleanup for you. UaApplicationDescription uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared ApplicationDescription it creates a copy for that (copy-on-write). So assigning another UaApplicationDescription or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.
Specifies an application that is available.
UaApplicationDescription::UaApplicationDescription | ( | const UaApplicationDescription & | other | ) |
Constructs an instance of the class UaApplicationDescription with values from another UaApplicationDescription object.
other | the other UaApplicationDescription used to initialize the object |
UaApplicationDescription::UaApplicationDescription | ( | const OpcUa_ApplicationDescription & | other | ) |
Constructs an instance of the class UaApplicationDescription with values from another OpcUa_ApplicationDescription structure.
other | the other OpcUa_ApplicationDescription used to initialize the object |
UaApplicationDescription::UaApplicationDescription | ( | const UaExtensionObject & | extensionObject | ) |
Constructs an instance of the class UaApplicationDescription initialized with value from a UaExtensionObject.
extensionObject | the extension object containing the ApplicationDescription |
UaApplicationDescription::UaApplicationDescription | ( | const OpcUa_ExtensionObject & | extensionObject | ) |
Constructs an instance of the class UaApplicationDescription initialized with value from an OpcUa_ExtensionObject structure.
extensionObject | the extension object containing the ApplicationDescription |
void UaApplicationDescription::attach | ( | OpcUa_ApplicationDescription * | pValue | ) |
Attaches to an existing OpcUa_ApplicationDescription structure.
Don't manually free the attached structure afterwards, because UaApplicationDescription is responsible for it now.
pValue | [in] Parameter to attach to. |
void UaApplicationDescription::clear | ( | ) |
Clear the data of the UaApplicationDescription.
|
static |
Copy OpcUa_ApplicationDescription data to a newly allocated OpcUa_ApplicationDescription.
source | Source to clone. |
|
static |
Copy OpcUa_ApplicationDescription data to an existing OpcUa_ApplicationDescription structure.
source | the source of the clone operation. |
copy | the destination of the clone operation. |
OpcUa_ApplicationDescription * UaApplicationDescription::copy | ( | ) | const |
Copy UaApplicationDescription data to a newly allocated OpcUa_ApplicationDescription.
void UaApplicationDescription::copyTo | ( | OpcUa_ApplicationDescription * | pDst | ) | const |
Copy UaApplicationDescription data to an existing OpcUa_ApplicationDescription structure.
pDst | the destination of this copy operation. |
OpcUa_ApplicationDescription * UaApplicationDescription::detach | ( | OpcUa_ApplicationDescription * | pDst | ) |
Detaches the internal ApplicationDescription structure from this class.
This way you take over the control of freeing the ApplicationDescription data. If more than one reference exists, the data is copied to pDst instead of being detached.
pDst | [out] Pointer to an OpcUa_ApplicationDescription structure that receives the ApplicationDescription data. |
OpcUa_ApplicationType UaApplicationDescription::getApplicationType | ( | ) | const |
The type of application.
UaString UaApplicationDescription::getApplicationUri | ( | ) | const |
The globally unique identifier for the application instance.
This URI is used as ServerUri in Services if the application is a Server.
UaString UaApplicationDescription::getDiscoveryProfileUri | ( | ) | const |
A URI that identifies the discovery profile supported by the URLs provided.
This field is not used if the ApplicationType is client.
void UaApplicationDescription::getDiscoveryUrls | ( | UaStringArray & | discoveryUrls | ) | const |
A list of URLs for the discovery Endpoints provided by the application.
If the ApplicationType is Client, this field shall contain an empty list.
UaString UaApplicationDescription::getGatewayServerUri | ( | ) | const |
A URI that identifies the Gateway Server associated with the DiscoveryUrls.
This value is not specified if the Server can be accessed directly.
This field is not used if the ApplicationType is Client.
bool UaApplicationDescription::operator!= | ( | const UaApplicationDescription & | other | ) | const |
Compare two UaApplicationDescription for inequality.
other | the UaApplicationDescription to compare with. |
UaApplicationDescription & UaApplicationDescription::operator= | ( | const UaApplicationDescription & | other | ) |
Assignment operator.
other | the UaApplicationDescription to assign. |
bool UaApplicationDescription::operator== | ( | const UaApplicationDescription & | other | ) | const |
Compare two UaApplicationDescription for equality.
other | the UaApplicationDescription to compare with. |
void UaApplicationDescription::setApplicationType | ( | OpcUa_ApplicationType | applicationType | ) |
The type of application.
void UaApplicationDescription::setApplicationUri | ( | const UaString & | applicationUri | ) |
The globally unique identifier for the application instance.
This URI is used as ServerUri in Services if the application is a Server.
void UaApplicationDescription::setDiscoveryProfileUri | ( | const UaString & | discoveryProfileUri | ) |
A URI that identifies the discovery profile supported by the URLs provided.
This field is not used if the ApplicationType is client.
void UaApplicationDescription::setDiscoveryUrls | ( | const UaStringArray & | discoveryUrls | ) |
A list of URLs for the discovery Endpoints provided by the application.
If the ApplicationType is Client, this field shall contain an empty list.
void UaApplicationDescription::setGatewayServerUri | ( | const UaString & | gatewayServerUri | ) |
A URI that identifies the Gateway Server associated with the DiscoveryUrls.
This value is not specified if the Server can be accessed directly.
This field is not used if the ApplicationType is Client.