C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
UaIdentityMappingRuleType Class Reference

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

#include <uaidentitymappingruletype.h>

Public Member Functions

 UaIdentityMappingRuleType ()
 Constructs an instance of the class UaIdentityMappingRuleType with empty default values.
 
 UaIdentityMappingRuleType (const UaIdentityMappingRuleType &other)
 Constructs an instance of the class UaIdentityMappingRuleType with values from another UaIdentityMappingRuleType object. More...
 
 UaIdentityMappingRuleType (const OpcUa_IdentityMappingRuleType &other)
 Constructs an instance of the class UaIdentityMappingRuleType with values from another OpcUa_IdentityMappingRuleType structure. More...
 
 UaIdentityMappingRuleType (OpcUa_IdentityCriteriaType criteriaType, const UaString &criteria)
 Constructs an instance of the class UaIdentityMappingRuleType with values provided in the constructor.
 
 UaIdentityMappingRuleType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaIdentityMappingRuleType initialized with value from a UaExtensionObject. More...
 
 UaIdentityMappingRuleType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaIdentityMappingRuleType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaIdentityMappingRuleType ()
 Destroys the UaIdentityMappingRuleType object.
 
void clear ()
 Clear the data of the UaIdentityMappingRuleType. More...
 
bool operator== (const UaIdentityMappingRuleType &other) const
 Compare two UaIdentityMappingRuleType for equality. More...
 
bool operator!= (const UaIdentityMappingRuleType &other) const
 Compare two UaIdentityMappingRuleType for inequality. More...
 
UaIdentityMappingRuleTypeoperator= (const UaIdentityMappingRuleType &other)
 Assignment operator. More...
 
OpcUa_IdentityMappingRuleType * copy () const
 Copy UaIdentityMappingRuleType data to a newly allocated OpcUa_IdentityMappingRuleType. More...
 
void copyTo (OpcUa_IdentityMappingRuleType *pDst) const
 Copy UaIdentityMappingRuleType data to an existing OpcUa_IdentityMappingRuleType structure. More...
 
void attach (OpcUa_IdentityMappingRuleType *pValue)
 Attaches to an existing OpcUa_IdentityMappingRuleType structure. More...
 
OpcUa_IdentityMappingRuleType * detach (OpcUa_IdentityMappingRuleType *pDst)
 Detaches the internal IdentityMappingRuleType structure from this class. More...
 
OpcUa_IdentityCriteriaType getCriteriaType () const
 Returns the CriteriaType.
 
UaString getCriteria () const
 Returns the Criteria.
 
void setCriteriaType (OpcUa_IdentityCriteriaType criteriaType)
 Sets the CriteriaType.
 
void setCriteria (const UaString &criteria)
 Sets the Criteria.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_IdentityMappingRuleType.

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

Constructor & Destructor Documentation

UaIdentityMappingRuleType::UaIdentityMappingRuleType ( const UaIdentityMappingRuleType other)

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

Parameters
otherthe other UaIdentityMappingRuleType used to initialize the object
UaIdentityMappingRuleType::UaIdentityMappingRuleType ( const OpcUa_IdentityMappingRuleType &  other)

Constructs an instance of the class UaIdentityMappingRuleType with values from another OpcUa_IdentityMappingRuleType structure.

Parameters
otherthe other OpcUa_IdentityMappingRuleType used to initialize the object
UaIdentityMappingRuleType::UaIdentityMappingRuleType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the IdentityMappingRuleType
UaIdentityMappingRuleType::UaIdentityMappingRuleType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the IdentityMappingRuleType

Member Function Documentation

void UaIdentityMappingRuleType::attach ( OpcUa_IdentityMappingRuleType *  pValue)

Attaches to an existing OpcUa_IdentityMappingRuleType structure.

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

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

Clear the data of the UaIdentityMappingRuleType.

OpcUa_IdentityMappingRuleType * UaIdentityMappingRuleType::clone ( const OpcUa_IdentityMappingRuleType &  source)
static

Copy OpcUa_IdentityMappingRuleType data to a newly allocated OpcUa_IdentityMappingRuleType.

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

Copy OpcUa_IdentityMappingRuleType data to an existing OpcUa_IdentityMappingRuleType structure.

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

Copy UaIdentityMappingRuleType data to a newly allocated OpcUa_IdentityMappingRuleType.

Returns
pointer to a newly allocated OpcUa_IdentityMappingRuleType.
void UaIdentityMappingRuleType::copyTo ( OpcUa_IdentityMappingRuleType *  pDst) const

Copy UaIdentityMappingRuleType data to an existing OpcUa_IdentityMappingRuleType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_IdentityMappingRuleType * UaIdentityMappingRuleType::detach ( OpcUa_IdentityMappingRuleType *  pDst)

Detaches the internal IdentityMappingRuleType structure from this class.

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

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

Compare two UaIdentityMappingRuleType for inequality.

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

Assignment operator.

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

Compare two UaIdentityMappingRuleType for equality.

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

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