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

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

#include <uausertokenpolicy.h>

Public Member Functions

 UaUserTokenPolicy ()
 Constructs an instance of the class UaUserTokenPolicy with empty default values.
 
 UaUserTokenPolicy (const UaUserTokenPolicy &other)
 Constructs an instance of the class UaUserTokenPolicy with values from another UaUserTokenPolicy object. More...
 
 UaUserTokenPolicy (const OpcUa_UserTokenPolicy &other)
 Constructs an instance of the class UaUserTokenPolicy with values from another OpcUa_UserTokenPolicy structure. More...
 
 UaUserTokenPolicy (const UaString &policyId, OpcUa_UserTokenType tokenType, const UaString &issuedTokenType, const UaString &issuerEndpointUrl, const UaString &securityPolicyUri)
 Constructs an instance of the class UaUserTokenPolicy with values provided in the constructor.
 
 UaUserTokenPolicy (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaUserTokenPolicy initialized with value from a UaExtensionObject. More...
 
 UaUserTokenPolicy (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaUserTokenPolicy initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaUserTokenPolicy ()
 Destroys the UaUserTokenPolicy object.
 
void clear ()
 Clear the data of the UaUserTokenPolicy. More...
 
bool operator== (const UaUserTokenPolicy &other) const
 Compare two UaUserTokenPolicy if they are similar. More...
 
bool operator!= (const UaUserTokenPolicy &other) const
 Returns true if the other UaUserTokenPolicy is not equal to this. More...
 
UaUserTokenPolicyoperator= (const UaUserTokenPolicy &other)
 Assignment operator. More...
 
OpcUa_UserTokenPolicy * copy () const
 Copy UaUserTokenPolicy data to a newly allocated OpcUa_UserTokenPolicy. More...
 
void copyTo (OpcUa_UserTokenPolicy *pDst) const
 Copy UaUserTokenPolicy data to an existing OpcUa_UserTokenPolicy structure. More...
 
void attach (OpcUa_UserTokenPolicy *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_UserTokenPolicy * detach (OpcUa_UserTokenPolicy *pDst)
 Detaches the internal UserTokenPolicy structure from this class. More...
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_UserTokenPolicy.

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

Constructor & Destructor Documentation

UaUserTokenPolicy::UaUserTokenPolicy ( const UaUserTokenPolicy other)

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

Parameters
otherthe other UaUserTokenPolicy used to initialize the object
UaUserTokenPolicy::UaUserTokenPolicy ( const OpcUa_UserTokenPolicy &  other)

Constructs an instance of the class UaUserTokenPolicy with values from another OpcUa_UserTokenPolicy structure.

Parameters
otherthe other OpcUa_UserTokenPolicy used to initialize the object
UaUserTokenPolicy::UaUserTokenPolicy ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the UserTokenPolicy
UaUserTokenPolicy::UaUserTokenPolicy ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the UserTokenPolicy

Member Function Documentation

void UaUserTokenPolicy::attach ( OpcUa_UserTokenPolicy *  pValue)

Attaches the data of the parameter pValue.

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

Parameters
[in]pValueParameter to attach to.
void UaUserTokenPolicy::clear ( )

Clear the data of the UaUserTokenPolicy.

OpcUa_UserTokenPolicy * UaUserTokenPolicy::clone ( const OpcUa_UserTokenPolicy &  source)
static

Copy OpcUa_UserTokenPolicy data to a newly allocated OpcUa_UserTokenPolicy.

Parameters
sourceSource to clone.
Returns
new copy.
void UaUserTokenPolicy::cloneTo ( const OpcUa_UserTokenPolicy &  source,
OpcUa_UserTokenPolicy &  copy 
)
static

Copy OpcUa_UserTokenPolicy data to an existing OpcUa_UserTokenPolicy structure.

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

Copy UaUserTokenPolicy data to a newly allocated OpcUa_UserTokenPolicy.

Returns
data to a newly allocated OpcUa_UserTokenPolicy.
void UaUserTokenPolicy::copyTo ( OpcUa_UserTokenPolicy *  pDst) const

Copy UaUserTokenPolicy data to an existing OpcUa_UserTokenPolicy structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_UserTokenPolicy * UaUserTokenPolicy::detach ( OpcUa_UserTokenPolicy *  pDst)

Detaches the internal UserTokenPolicy structure from this class.

This way you take over the control of releasing the UserTokenPolicy 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_UserTokenPolicy structure that receives the UserTokenPolicy data.
bool UaUserTokenPolicy::operator!= ( const UaUserTokenPolicy other) const

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

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

Assignment operator.

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

Compare two UaUserTokenPolicy if they are similar.

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

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