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 if they are similar. More...

bool	operator!= (const UaApplicationDescription &other) const
	Returns true if the other UaApplicationDescription is not equal to this. 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 the data of the parameter pValue. More...

OpcUa_ApplicationDescription *	detach (OpcUa_ApplicationDescription *pDst)
	Detaches the internal ApplicationDescription structure from this class. 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)
	Copy OpcUa_ApplicationDescription data to an existing OpcUa_ApplicationDescription structure. More...

Detailed Description

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.

Constructor & Destructor Documentation

UaApplicationDescription::UaApplicationDescription ( const UaApplicationDescription & other )

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

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

extensionObject the extension object containing the ApplicationDescription

Member Function Documentation

void UaApplicationDescription::attach ( OpcUa_ApplicationDescription * pValue )

Attaches the data of the parameter pValue.

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

Parameters

[in] pValue Parameter to attach to.

void UaApplicationDescription::clear ( )

Clear the data of the UaApplicationDescription.

OpcUa_ApplicationDescription * UaApplicationDescription::clone ( const OpcUa_ApplicationDescription & source )

static

Copy OpcUa_ApplicationDescription data to a newly allocated OpcUa_ApplicationDescription.

Parameters

source Source to clone.

Returns: new copy.

void UaApplicationDescription::cloneTo	(	const OpcUa_ApplicationDescription &	source,
		OpcUa_ApplicationDescription &	copy
	)

static

Copy OpcUa_ApplicationDescription data to an existing OpcUa_ApplicationDescription structure.

Parameters

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.

Returns: data to a newly allocated OpcUa_ApplicationDescription.

void UaApplicationDescription::copyTo ( OpcUa_ApplicationDescription * pDst ) const

Copy UaApplicationDescription data to an existing OpcUa_ApplicationDescription structure.

Parameters

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 releasing the ApplicationDescription 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_ApplicationDescription structure that receives the ApplicationDescription data.

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

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

See Also: operator==

Parameters

other the UaApplicationDescription to compare.

Returns: true if other is not equal to this.

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

Assignment operator.

Parameters

other the UaApplicationDescription to assign.

Returns: Assignment operator.

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

Compare two UaApplicationDescription if they are similar.

Parameters

other the UaApplicationDescription 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/uaapplicationdescription.h
D:/work/uasdkcpp/src/uabase/uabasecpp/uaapplicationdescription.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation