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

#include <uaendpointconfiguration.h>

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

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

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

	UaEndpointConfiguration (OpcUa_Int32 operationTimeout, OpcUa_Boolean useBinaryEncoding, OpcUa_Int32 maxStringLength, OpcUa_Int32 maxByteStringLength, OpcUa_Int32 maxArrayLength, OpcUa_Int32 maxMessageSize, OpcUa_Int32 maxBufferSize, OpcUa_Int32 channelLifetime, OpcUa_Int32 securityTokenLifetime)
	Constructs an instance of the class UaEndpointConfiguration with values provided in the constructor.

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

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

	~UaEndpointConfiguration ()
	Destroys the UaEndpointConfiguration object.

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

bool	operator== (const UaEndpointConfiguration &other) const
	Compare two UaEndpointConfiguration for equality. More...

bool	operator!= (const UaEndpointConfiguration &other) const
	Compare two UaEndpointConfiguration for inequality. More...

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

OpcUa_EndpointConfiguration *	copy () const
	Copy UaEndpointConfiguration data to a newly allocated OpcUa_EndpointConfiguration. More...

void	copyTo (OpcUa_EndpointConfiguration *pDst) const
	Copy UaEndpointConfiguration data to an existing OpcUa_EndpointConfiguration structure. More...

void	attach (OpcUa_EndpointConfiguration *pValue)
	Attaches to an existing OpcUa_EndpointConfiguration structure. More...

OpcUa_EndpointConfiguration *	detach (OpcUa_EndpointConfiguration *pDst)
	Detaches the internal EndpointConfiguration structure from this class. More...

OpcUa_Int32	getOperationTimeout () const
	Returns the OperationTimeout.

OpcUa_Boolean	getUseBinaryEncoding () const
	Returns the UseBinaryEncoding.

OpcUa_Int32	getMaxStringLength () const
	Returns the MaxStringLength.

OpcUa_Int32	getMaxByteStringLength () const
	Returns the MaxByteStringLength.

OpcUa_Int32	getMaxArrayLength () const
	Returns the MaxArrayLength.

OpcUa_Int32	getMaxMessageSize () const
	Returns the MaxMessageSize.

OpcUa_Int32	getMaxBufferSize () const
	Returns the MaxBufferSize.

OpcUa_Int32	getChannelLifetime () const
	Returns the ChannelLifetime.

OpcUa_Int32	getSecurityTokenLifetime () const
	Returns the SecurityTokenLifetime.

void	setOperationTimeout (OpcUa_Int32 operationTimeout)
	Sets the OperationTimeout.

void	setUseBinaryEncoding (OpcUa_Boolean useBinaryEncoding)
	Sets the UseBinaryEncoding.

void	setMaxStringLength (OpcUa_Int32 maxStringLength)
	Sets the MaxStringLength.

void	setMaxByteStringLength (OpcUa_Int32 maxByteStringLength)
	Sets the MaxByteStringLength.

void	setMaxArrayLength (OpcUa_Int32 maxArrayLength)
	Sets the MaxArrayLength.

void	setMaxMessageSize (OpcUa_Int32 maxMessageSize)
	Sets the MaxMessageSize.

void	setMaxBufferSize (OpcUa_Int32 maxBufferSize)
	Sets the MaxBufferSize.

void	setChannelLifetime (OpcUa_Int32 channelLifetime)
	Sets the ChannelLifetime.

void	setSecurityTokenLifetime (OpcUa_Int32 securityTokenLifetime)
	Sets the SecurityTokenLifetime.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_EndpointConfiguration.

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

Constructor & Destructor Documentation

UaEndpointConfiguration::UaEndpointConfiguration ( const UaEndpointConfiguration & other )

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

Parameters

other the other UaEndpointConfiguration used to initialize the object

UaEndpointConfiguration::UaEndpointConfiguration ( const OpcUa_EndpointConfiguration & other )

Constructs an instance of the class UaEndpointConfiguration with values from another OpcUa_EndpointConfiguration structure.

Parameters

other the other OpcUa_EndpointConfiguration used to initialize the object

UaEndpointConfiguration::UaEndpointConfiguration ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the EndpointConfiguration

UaEndpointConfiguration::UaEndpointConfiguration ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the EndpointConfiguration

Member Function Documentation

void UaEndpointConfiguration::attach ( OpcUa_EndpointConfiguration * pValue )

Attaches to an existing OpcUa_EndpointConfiguration structure.

Don't manually free the attached structure afterwards, because UaEndpointConfiguration is responsible for it now.

Parameters

pValue [in] Parameter to attach to.

void UaEndpointConfiguration::clear ( )

Clear the data of the UaEndpointConfiguration.

OpcUa_EndpointConfiguration * UaEndpointConfiguration::clone ( const OpcUa_EndpointConfiguration & source )

static

Copy OpcUa_EndpointConfiguration data to a newly allocated OpcUa_EndpointConfiguration.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_EndpointConfiguration.

void UaEndpointConfiguration::cloneTo	(	const OpcUa_EndpointConfiguration &	source,
		OpcUa_EndpointConfiguration &	copy
	)

static

Copy OpcUa_EndpointConfiguration data to an existing OpcUa_EndpointConfiguration structure.

Parameters

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

OpcUa_EndpointConfiguration * UaEndpointConfiguration::copy ( ) const

Copy UaEndpointConfiguration data to a newly allocated OpcUa_EndpointConfiguration.

Returns: pointer to a newly allocated OpcUa_EndpointConfiguration.

void UaEndpointConfiguration::copyTo ( OpcUa_EndpointConfiguration * pDst ) const

Copy UaEndpointConfiguration data to an existing OpcUa_EndpointConfiguration structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_EndpointConfiguration * UaEndpointConfiguration::detach ( OpcUa_EndpointConfiguration * pDst )

Detaches the internal EndpointConfiguration structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_EndpointConfiguration structure that receives the EndpointConfiguration data.

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

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

Compare two UaEndpointConfiguration for inequality.

See also: operator==

Parameters

other the UaEndpointConfiguration to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaEndpointConfiguration to assign.

Returns: reference to itself.

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

Compare two UaEndpointConfiguration for equality.

Parameters

other the UaEndpointConfiguration to compare with.

Returns: true if equal, false if not.

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

C:/work/uasdkcpp/src/uabase/uabasecpp/uaendpointconfiguration.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uaendpointconfiguration.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation