C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

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

#include <uaendpointtype.h>

Public Member Functions

 UaEndpointType ()
 Constructs an instance of the class UaEndpointType with empty default values.
 
 UaEndpointType (const UaEndpointType &other)
 Constructs an instance of the class UaEndpointType with values from another UaEndpointType object. More...
 
 UaEndpointType (const OpcUa_EndpointType &other)
 Constructs an instance of the class UaEndpointType with values from another OpcUa_EndpointType structure. More...
 
 UaEndpointType (const UaString &endpointUrl, OpcUa_MessageSecurityMode securityMode, const UaString &securityPolicyUri, const UaString &transportProfileUri)
 Constructs an instance of the class UaEndpointType with values provided in the constructor.
 
 UaEndpointType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaEndpointType initialized with value from a UaExtensionObject. More...
 
 UaEndpointType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaEndpointType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaEndpointType ()
 Destroys the UaEndpointType object.
 
void clear ()
 Clear the data of the UaEndpointType. More...
 
bool operator== (const UaEndpointType &other) const
 Compare two UaEndpointType for equality. More...
 
bool operator!= (const UaEndpointType &other) const
 Compare two UaEndpointType for inequality. More...
 
UaEndpointTypeoperator= (const UaEndpointType &other)
 Assignment operator. More...
 
OpcUa_EndpointType * copy () const
 Copy UaEndpointType data to a newly allocated OpcUa_EndpointType. More...
 
void copyTo (OpcUa_EndpointType *pDst) const
 Copy UaEndpointType data to an existing OpcUa_EndpointType structure. More...
 
void attach (OpcUa_EndpointType *pValue)
 Attaches to an existing OpcUa_EndpointType structure. More...
 
OpcUa_EndpointType * detach (OpcUa_EndpointType *pDst)
 Detaches the internal EndpointType structure from this class. More...
 
UaString getEndpointUrl () const
 Returns the EndpointUrl.
 
OpcUa_MessageSecurityMode getSecurityMode () const
 Returns the SecurityMode.
 
UaString getSecurityPolicyUri () const
 Returns the SecurityPolicyUri.
 
UaString getTransportProfileUri () const
 Returns the TransportProfileUri.
 
void setEndpointUrl (const UaString &endpointUrl)
 Sets the EndpointUrl.
 
void setSecurityMode (OpcUa_MessageSecurityMode securityMode)
 Sets the SecurityMode.
 
void setSecurityPolicyUri (const UaString &securityPolicyUri)
 Sets the SecurityPolicyUri.
 
void setTransportProfileUri (const UaString &transportProfileUri)
 Sets the TransportProfileUri.
 

Static Public Member Functions

static OpcUa_EndpointType * clone (const OpcUa_EndpointType &source)
 Copy OpcUa_EndpointType data to a newly allocated OpcUa_EndpointType. More...
 
static void cloneTo (const OpcUa_EndpointType &source, OpcUa_EndpointType &copy)
 Copy OpcUa_EndpointType data to an existing OpcUa_EndpointType structure. More...
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_EndpointType.

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

Constructor & Destructor Documentation

UaEndpointType::UaEndpointType ( const UaEndpointType other)

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

Parameters
otherthe other UaEndpointType used to initialize the object
UaEndpointType::UaEndpointType ( const OpcUa_EndpointType &  other)

Constructs an instance of the class UaEndpointType with values from another OpcUa_EndpointType structure.

Parameters
otherthe other OpcUa_EndpointType used to initialize the object
UaEndpointType::UaEndpointType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the EndpointType
UaEndpointType::UaEndpointType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the EndpointType

Member Function Documentation

void UaEndpointType::attach ( OpcUa_EndpointType *  pValue)

Attaches to an existing OpcUa_EndpointType structure.

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

Parameters
pValue[in] Parameter to attach to.
void UaEndpointType::clear ( )

Clear the data of the UaEndpointType.

OpcUa_EndpointType * UaEndpointType::clone ( const OpcUa_EndpointType &  source)
static

Copy OpcUa_EndpointType data to a newly allocated OpcUa_EndpointType.

Parameters
sourceSource to clone.
Returns
pointer to a newly allocated OpcUa_EndpointType.
void UaEndpointType::cloneTo ( const OpcUa_EndpointType &  source,
OpcUa_EndpointType &  copy 
)
static

Copy OpcUa_EndpointType data to an existing OpcUa_EndpointType structure.

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

Copy UaEndpointType data to a newly allocated OpcUa_EndpointType.

Returns
pointer to a newly allocated OpcUa_EndpointType.
void UaEndpointType::copyTo ( OpcUa_EndpointType *  pDst) const

Copy UaEndpointType data to an existing OpcUa_EndpointType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_EndpointType * UaEndpointType::detach ( OpcUa_EndpointType *  pDst)

Detaches the internal EndpointType structure from this class.

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

Parameters
pDst[out] Pointer to an OpcUa_EndpointType structure that receives the EndpointType data.
Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
bool UaEndpointType::operator!= ( const UaEndpointType other) const

Compare two UaEndpointType for inequality.

See also
operator==
Parameters
otherthe UaEndpointType to compare with.
Returns
true if not equal, false otherwise.
UaEndpointType & UaEndpointType::operator= ( const UaEndpointType other)

Assignment operator.

Parameters
otherthe UaEndpointType to assign.
Returns
reference to itself.
bool UaEndpointType::operator== ( const UaEndpointType other) const

Compare two UaEndpointType for equality.

Parameters
otherthe UaEndpointType to compare with.
Returns
true if equal, false if not.

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