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

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

#include <uarolepermissiontype.h>

Public Member Functions

 UaRolePermissionType ()
 Constructs an instance of the class UaRolePermissionType with empty default values.
 
 UaRolePermissionType (const UaRolePermissionType &other)
 Constructs an instance of the class UaRolePermissionType with values from another UaRolePermissionType object. More...
 
 UaRolePermissionType (const OpcUa_RolePermissionType &other)
 Constructs an instance of the class UaRolePermissionType with values from another OpcUa_RolePermissionType structure. More...
 
 UaRolePermissionType (const UaNodeId &roleId, OpcUa_PermissionType permissions)
 Constructs an instance of the class UaRolePermissionType with values provided in the constructor.
 
 UaRolePermissionType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaRolePermissionType initialized with value from a UaExtensionObject. More...
 
 UaRolePermissionType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaRolePermissionType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaRolePermissionType ()
 Destroys the UaRolePermissionType object.
 
void clear ()
 Clear the data of the UaRolePermissionType. More...
 
bool operator== (const UaRolePermissionType &other) const
 Compare two UaRolePermissionType for equality. More...
 
bool operator!= (const UaRolePermissionType &other) const
 Compare two UaRolePermissionType for inequality. More...
 
UaRolePermissionTypeoperator= (const UaRolePermissionType &other)
 Assignment operator. More...
 
OpcUa_RolePermissionType * copy () const
 Copy UaRolePermissionType data to a newly allocated OpcUa_RolePermissionType. More...
 
void copyTo (OpcUa_RolePermissionType *pDst) const
 Copy UaRolePermissionType data to an existing OpcUa_RolePermissionType structure. More...
 
void attach (OpcUa_RolePermissionType *pValue)
 Attaches to an existing OpcUa_RolePermissionType structure. More...
 
OpcUa_RolePermissionType * detach (OpcUa_RolePermissionType *pDst)
 Detaches the internal RolePermissionType structure from this class. More...
 
UaNodeId getRoleId () const
 Returns the RoleId.
 
OpcUa_PermissionType getPermissions () const
 Returns the Permissions.
 
void setRoleId (const UaNodeId &roleId)
 Sets the RoleId.
 
void setPermissions (OpcUa_PermissionType permissions)
 Sets the Permissions.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_RolePermissionType.

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

Constructor & Destructor Documentation

UaRolePermissionType::UaRolePermissionType ( const UaRolePermissionType other)

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

Parameters
otherthe other UaRolePermissionType used to initialize the object
UaRolePermissionType::UaRolePermissionType ( const OpcUa_RolePermissionType &  other)

Constructs an instance of the class UaRolePermissionType with values from another OpcUa_RolePermissionType structure.

Parameters
otherthe other OpcUa_RolePermissionType used to initialize the object
UaRolePermissionType::UaRolePermissionType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the RolePermissionType
UaRolePermissionType::UaRolePermissionType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the RolePermissionType

Member Function Documentation

void UaRolePermissionType::attach ( OpcUa_RolePermissionType *  pValue)

Attaches to an existing OpcUa_RolePermissionType structure.

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

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

Clear the data of the UaRolePermissionType.

OpcUa_RolePermissionType * UaRolePermissionType::clone ( const OpcUa_RolePermissionType &  source)
static

Copy OpcUa_RolePermissionType data to a newly allocated OpcUa_RolePermissionType.

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

Copy OpcUa_RolePermissionType data to an existing OpcUa_RolePermissionType structure.

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

Copy UaRolePermissionType data to a newly allocated OpcUa_RolePermissionType.

Returns
pointer to a newly allocated OpcUa_RolePermissionType.
void UaRolePermissionType::copyTo ( OpcUa_RolePermissionType *  pDst) const

Copy UaRolePermissionType data to an existing OpcUa_RolePermissionType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_RolePermissionType * UaRolePermissionType::detach ( OpcUa_RolePermissionType *  pDst)

Detaches the internal RolePermissionType structure from this class.

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

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

Compare two UaRolePermissionType for inequality.

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

Assignment operator.

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

Compare two UaRolePermissionType for equality.

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

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