Wrapper class for the UA stack structure OpcUa_EndpointDescription. More...

#include <uaendpointdescription.h>

Public Member Functions
	UaEndpointDescription ()
	Constructs an instance of the class UaEndpointDescription with empty default values.

	UaEndpointDescription (const UaEndpointDescription &other)
	Constructs an instance of the class UaEndpointDescription with values from another UaEndpointDescription object. More...

	UaEndpointDescription (const OpcUa_EndpointDescription &other)
	Constructs an instance of the class UaEndpointDescription with values from another OpcUa_EndpointDescription structure. More...

	UaEndpointDescription (const UaString &endpointUrl, const UaApplicationDescription &server, const UaByteString &serverCertificate, OpcUa_MessageSecurityMode securityMode, const UaString &securityPolicyUri, const UaUserTokenPolicys &userIdentityTokens, const UaString &transportProfileUri, OpcUa_Byte securityLevel)
	Constructs an instance of the class UaEndpointDescription with values provided in the constructor.

	UaEndpointDescription (const UaExtensionObject &extensionObject)
	Constructs an instance of the class UaEndpointDescription initialized with value from a UaExtensionObject. More...

	UaEndpointDescription (const OpcUa_ExtensionObject &extensionObject)
	Constructs an instance of the class UaEndpointDescription initialized with value from an OpcUa_ExtensionObject structure. More...

	UaEndpointDescription (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)

	UaEndpointDescription (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)

	~UaEndpointDescription ()
	Destroys the UaEndpointDescription object.

void	clear ()
	Clear the data of the UaEndpointDescription. More...

bool	operator== (const UaEndpointDescription &other) const
	Compare two UaEndpointDescription if they are similar. More...

bool	operator!= (const UaEndpointDescription &other) const
	Returns true if the other UaEndpointDescription is not equal to this. More...

UaEndpointDescription &	operator= (const UaEndpointDescription &other)
	Assignment operator. More...

OpcUa_EndpointDescription *	copy () const
	Copy UaEndpointDescription data to a newly allocated OpcUa_EndpointDescription. More...

void	copyTo (OpcUa_EndpointDescription *pDst) const
	Copy UaEndpointDescription data to an existing OpcUa_EndpointDescription structure. More...

void	attach (const OpcUa_EndpointDescription *pValue)
	Attaches the data of the parameter pValue. More...

OpcUa_EndpointDescription *	detach (OpcUa_EndpointDescription *pDst)
	Detaches the internal EndpointDescription structure from this class. More...

void	toVariant (UaVariant &variant) const

void	toVariant (OpcUa_Variant &variant) const

void	toVariant (UaVariant &variant, OpcUa_Boolean bDetach)

void	toVariant (OpcUa_Variant &variant, OpcUa_Boolean bDetach)

void	toDataValue (UaDataValue &dataValue, OpcUa_Boolean updateTimeStamps) const

void	toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean updateTimeStamps) const

void	toDataValue (UaDataValue &dataValue, OpcUa_Boolean bDetach, OpcUa_Boolean updateTimeStamps)

void	toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean bDetach, OpcUa_Boolean updateTimeStamps)

void	toExtensionObject (UaExtensionObject &extensionObject) const

void	toExtensionObject (OpcUa_ExtensionObject &extensionObject) const

void	toExtensionObject (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)

void	toExtensionObject (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)

OpcUa_StatusCode	setEndpointDescription (const UaExtensionObject &extensionObject)

OpcUa_StatusCode	setEndpointDescription (const OpcUa_ExtensionObject &extensionObject)

OpcUa_StatusCode	setEndpointDescription (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)

OpcUa_StatusCode	setEndpointDescription (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)

void	setEndpointDescription (const UaString &endpointUrl, const UaApplicationDescription &server, const UaByteString &serverCertificate, OpcUa_MessageSecurityMode securityMode, const UaString &securityPolicyUri, const UaUserTokenPolicys &userIdentityTokens, const UaString &transportProfileUri, OpcUa_Byte securityLevel)

UaString	getEndpointUrl () const

UaApplicationDescription	getServer () const

UaByteString	getServerCertificate () const

OpcUa_MessageSecurityMode	getSecurityMode () const

UaString	getSecurityPolicyUri () const

void	getUserIdentityTokens (UaUserTokenPolicys &userIdentityTokens) const

UaString	getTransportProfileUri () const

OpcUa_Byte	getSecurityLevel () const

void	setEndpointUrl (const UaString &endpointUrl)

void	setServer (const UaApplicationDescription &server)

void	setServerCertificate (const UaByteString &serverCertificate)

void	setSecurityMode (OpcUa_MessageSecurityMode securityMode)

void	setSecurityPolicyUri (const UaString &securityPolicyUri)

void	setUserIdentityTokens (const UaUserTokenPolicys &userIdentityTokens)

void	setTransportProfileUri (const UaString &transportProfileUri)

void	setSecurityLevel (OpcUa_Byte securityLevel)

Static Public Member Functions
static OpcUa_EndpointDescription *	clone (const OpcUa_EndpointDescription &source)
	Copy OpcUa_EndpointDescription data to a newly allocated OpcUa_EndpointDescription. More...

static void	cloneTo (const OpcUa_EndpointDescription &source, OpcUa_EndpointDescription &copy)
	Copy OpcUa_EndpointDescription data to an existing OpcUa_EndpointDescription structure. More...

Detailed Description

Wrapper class for the UA stack structure OpcUa_EndpointDescription.

This class encapsulates the native OpcUa_EndpointDescription structure and handles memory allocation and cleanup for you. UaEndpointDescription uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared EndpointDescription it creates a copy for that (copy-on-write). So assigning another UaEndpointDescription or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.

Constructor & Destructor Documentation

UaEndpointDescription::UaEndpointDescription ( const UaEndpointDescription & other )

Constructs an instance of the class UaEndpointDescription with values from another UaEndpointDescription object.

Parameters

other the other UaEndpointDescription used to initialize the object

UaEndpointDescription::UaEndpointDescription ( const OpcUa_EndpointDescription & other )

Constructs an instance of the class UaEndpointDescription with values from another OpcUa_EndpointDescription structure.

Parameters

other the other OpcUa_EndpointDescription used to initialize the object

UaEndpointDescription::UaEndpointDescription ( const UaExtensionObject & extensionObject )

Constructs an instance of the class UaEndpointDescription initialized with value from a UaExtensionObject.

Parameters

extensionObject the extension object containing the EndpointDescription

UaEndpointDescription::UaEndpointDescription ( const OpcUa_ExtensionObject & extensionObject )

Constructs an instance of the class UaEndpointDescription initialized with value from an OpcUa_ExtensionObject structure.

Parameters

extensionObject the extension object containing the EndpointDescription

Member Function Documentation

void UaEndpointDescription::attach ( const OpcUa_EndpointDescription * pValue )

Attaches the data of the parameter pValue.

Don't clear the data of pValue afterwards manually, because UaEndpointDescription is responsible for it now.

Parameters

[in] pValue Parameter to attach to.

void UaEndpointDescription::clear ( )

Clear the data of the UaEndpointDescription.

OpcUa_EndpointDescription * UaEndpointDescription::clone ( const OpcUa_EndpointDescription & source )

static

Copy OpcUa_EndpointDescription data to a newly allocated OpcUa_EndpointDescription.

Parameters

source Source to clone.

Returns: new copy.

void UaEndpointDescription::cloneTo	(	const OpcUa_EndpointDescription &	source,
		OpcUa_EndpointDescription &	copy
	)

static

Copy OpcUa_EndpointDescription data to an existing OpcUa_EndpointDescription structure.

Parameters

source	the source of the clone operation.
copy	the destination of the clone operation.

OpcUa_EndpointDescription * UaEndpointDescription::copy ( ) const

Copy UaEndpointDescription data to a newly allocated OpcUa_EndpointDescription.

Returns: data to a newly allocated OpcUa_EndpointDescription.

void UaEndpointDescription::copyTo ( OpcUa_EndpointDescription * pDst ) const

Copy UaEndpointDescription data to an existing OpcUa_EndpointDescription structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_EndpointDescription * UaEndpointDescription::detach ( OpcUa_EndpointDescription * pDst )

Detaches the internal EndpointDescription structure from this class.

This way you take over the control of releasing the EndpointDescription data. If more than one reference exists, the data is copied to pDst instead of being detached.

Returns: If the function succeeds, pDst is returned, otherwise 0 is returned.

Parameters

[out] pDst Pointer to OpcUa_EndpointDescription structure that receives the EndpointDescription data.

bool UaEndpointDescription::operator!= ( const UaEndpointDescription & other ) const

Returns true if the other UaEndpointDescription is not equal to this.

See Also: operator==

Parameters

other the UaEndpointDescription to compare.

Returns: true if other is not equal to this.

UaEndpointDescription & UaEndpointDescription::operator= ( const UaEndpointDescription & other )

Assignment operator.

Parameters

other the UaEndpointDescription to assign.

Returns: Assignment operator.

bool UaEndpointDescription::operator== ( const UaEndpointDescription & other ) const

Compare two UaEndpointDescription if they are similar.

Parameters

other the UaEndpointDescription to compare.

Returns: true if similar, false if not.

The documentation for this class was generated from the following files:

D:/work/uasdkcpp/src/uabase/uabasecpp/uaendpointdescription.h
D:/work/uasdkcpp/src/uabase/uabasecpp/uaendpointdescription.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation