UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UaEndpointConfiguration Class Reference

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 if they are similar. More...
 
bool operator!= (const UaEndpointConfiguration &other) const
 Returns true if the other UaEndpointConfiguration is not equal to this. More...
 
UaEndpointConfigurationoperator= (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 the data of the parameter pValue. More...
 
OpcUa_EndpointConfiguration * detach (OpcUa_EndpointConfiguration *pDst)
 Detaches the internal EndpointConfiguration structure from this class. More...
 

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
otherthe 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
otherthe 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
extensionObjectthe 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
extensionObjectthe extension object containing the EndpointConfiguration

Member Function Documentation

void UaEndpointConfiguration::attach ( OpcUa_EndpointConfiguration *  pValue)

Attaches the data of the parameter pValue.

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

Parameters
[in]pValueParameter 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
sourceSource to clone.
Returns
new copy.
void UaEndpointConfiguration::cloneTo ( const OpcUa_EndpointConfiguration &  source,
OpcUa_EndpointConfiguration &  copy 
)
static

Copy OpcUa_EndpointConfiguration data to an existing OpcUa_EndpointConfiguration structure.

Parameters
sourcethe source of the clone operation.
copythe destination of the clone operation.
OpcUa_EndpointConfiguration * UaEndpointConfiguration::copy ( ) const

Copy UaEndpointConfiguration data to a newly allocated OpcUa_EndpointConfiguration.

Returns
data to a newly allocated OpcUa_EndpointConfiguration.
void UaEndpointConfiguration::copyTo ( OpcUa_EndpointConfiguration *  pDst) const

Copy UaEndpointConfiguration data to an existing OpcUa_EndpointConfiguration structure.

Parameters
pDstthe 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 releasing the EndpointConfiguration 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]pDstPointer to OpcUa_EndpointConfiguration structure that receives the EndpointConfiguration data.
bool UaEndpointConfiguration::operator!= ( const UaEndpointConfiguration other) const

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

See Also
operator==
Parameters
otherthe UaEndpointConfiguration to compare.
Returns
true if other is not equal to this.
UaEndpointConfiguration & UaEndpointConfiguration::operator= ( const UaEndpointConfiguration other)

Assignment operator.

Parameters
otherthe UaEndpointConfiguration to assign.
Returns
Assignment operator.
bool UaEndpointConfiguration::operator== ( const UaEndpointConfiguration other) const

Compare two UaEndpointConfiguration if they are similar.

Parameters
otherthe UaEndpointConfiguration to compare.
Returns
true if similar, false if not.

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