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

#include <uamodule_durablesubscriptiondatatype.h>

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

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

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

	DurableSubscriptionDataType (OpcUa_Double PublishingInterval, OpcUa_UInt32 MaxKeepAliveCount, OpcUa_UInt32 LifeTimeInHours, OpcUa_UInt32 MaxNotificationsPerPublish, OpcUa_Boolean PublishingEnabled, OpcUa_Byte Priority, const DurableMonitoredItemDataTypes &MonitoredItems, const UaString &ClientUserId, OpcUa_Byte UserTokenType, const UaNodeIdArray &UserRoles, const UaStringArray &Namespaces)
	Constructs an instance of the class DurableSubscriptionDataType with values provided in the constructor.

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

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

	~DurableSubscriptionDataType ()
	Destroys the DurableSubscriptionDataType object.

void	clear ()
	Clear the data of the DurableSubscriptionDataType.

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

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

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

UaModule_DurableSubscriptionDataType *	copy () const
	Copy DurableSubscriptionDataType data to a newly allocated UaModule_DurableSubscriptionDataType. More...

void	copyTo (UaModule_DurableSubscriptionDataType *pDst) const
	Copy DurableSubscriptionDataType data to an existing UaModule_DurableSubscriptionDataType structure. More...

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

UaModule_DurableSubscriptionDataType *	detach (UaModule_DurableSubscriptionDataType *pDst)
	Detaches the internal DurableSubscriptionDataType structure from this class. More...

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

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

Detailed Description

Wrapper class for the UA stack structure UaModule_DurableSubscriptionDataType.

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

Constructor & Destructor Documentation

DurableSubscriptionDataType::DurableSubscriptionDataType ( const DurableSubscriptionDataType & other )

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

Parameters

other the other UaDurableSubscriptionDataType used to initialize the object

DurableSubscriptionDataType::DurableSubscriptionDataType ( const UaModule_DurableSubscriptionDataType & other )

Constructs an instance of the class DurableSubscriptionDataType with values from another UaModule_DurableSubscriptionDataType structure.

Parameters

other the other UaModule_DurableSubscriptionDataType used to initialize the object

DurableSubscriptionDataType::DurableSubscriptionDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the DurableSubscriptionDataType

DurableSubscriptionDataType::DurableSubscriptionDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the DurableSubscriptionDataType

Member Function Documentation

void DurableSubscriptionDataType::attach ( const UaModule_DurableSubscriptionDataType * pValue )

Attaches the data of the parameter pValue.

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

Parameters

[in] pValue Parameter to attach to.

UaModule_DurableSubscriptionDataType * DurableSubscriptionDataType::clone ( const UaModule_DurableSubscriptionDataType & source )

static

Copy UaModule_DurableSubscriptionDataType data to a newly allocated UaModule_DurableSubscriptionDataType.

Parameters

source Source to clone.

Returns: new copy.

void DurableSubscriptionDataType::cloneTo	(	const UaModule_DurableSubscriptionDataType &	source,
		UaModule_DurableSubscriptionDataType &	copy
	)

static

Copy UaModule_DurableSubscriptionDataType data to an existing UaModule_DurableSubscriptionDataType structure.

Parameters

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

UaModule_DurableSubscriptionDataType * DurableSubscriptionDataType::copy ( ) const

Copy DurableSubscriptionDataType data to a newly allocated UaModule_DurableSubscriptionDataType.

Returns: data to a newly allocated UaModule_DurableSubscriptionDataType.

void DurableSubscriptionDataType::copyTo ( UaModule_DurableSubscriptionDataType * pDst ) const

Copy DurableSubscriptionDataType data to an existing UaModule_DurableSubscriptionDataType structure.

Parameters

pDst	the destination of this copy operation.

UaModule_DurableSubscriptionDataType * DurableSubscriptionDataType::detach ( UaModule_DurableSubscriptionDataType * pDst )

Detaches the internal DurableSubscriptionDataType structure from this class.

This way you take over the control of releasing the DurableSubscriptionDataType data. If more than one references exist, the data is copied to pDst instead of being detached.

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

Parameters

[out] pDst Pointer to UaModule_DurableSubscriptionDataType structure that receives the DurableSubscriptionDataType data.

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

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

See also: operator==

Parameters

other the DurableSubscriptionDataType to compare.

Returns: true if other is not equal to this.

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

Assignment operator.

Parameters

other the DurableSubscriptionDataType to assign.

Returns: Assignment operator.

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

Compare two DurableSubscriptionDataType if they are similar.

Parameters

other the DurableSubscriptionDataType to compare.

Returns: true if similar, false if not.

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

D:/work/uasdkcpp/src/uaserver/uaservercpp/uamodule/uamodule_durablesubscriptiondatatype.h
D:/work/uasdkcpp/src/uaserver/uaservercpp/uamodule/uamodule_durablesubscriptiondatatype.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation