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

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

#include <uaguid.h>

Inherits OpcUa_Guid.

Public Member Functions

 UaGuid ()
 construction
 
 UaGuid (const UaGuid &other)
 construction More...
 
 UaGuid (const OpcUa_Guid &other)
 construction More...
 
 ~UaGuid ()
 destruction
 
void clear ()
 Clear the data of the UaGuid. More...
 
UaGuidoperator= (const UaGuid &other)
 Assignment operator. More...
 
bool operator== (const UaGuid &other) const
 Compare variables if they are similar. More...
 
bool operator!= (const UaGuid &other) const
 Returns true if other is not equal to this. More...
 
bool operator< (const UaGuid &) const
 Is lower than operator. More...
 
bool operator> (const UaGuid &) const
 Is greater than operator. More...
 
bool isNull () const
 Compares the value of two structures. More...
 
 operator const OpcUa_Guid * () const
 Return internal OpcUa_UaGuid structure. More...
 
OpcUa_Guidcopy () const
 Copy Guid to a newly allocated OpcUa_Guid. More...
 
void copyTo (OpcUa_Guid *pDst) const
 Copy Guid data to an existing OpcUa_Guid structure. More...
 
UaString toString () const
 Converts the GUID to a string. More...
 
OpcUa_StatusCode fromString (const UaString &)
 Converts a UTF-8 string representation of a GUID to a binary representation. More...
 

Static Public Member Functions

static UaGuid create ()
 Create a new GUID. More...
 
static bool compare (const OpcUa_Guid &, const OpcUa_Guid &)
 Compares the value of two structures. More...
 
static OpcUa_Guidclone (const OpcUa_Guid &source)
 Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes. More...
 
static void cloneTo (const OpcUa_Guid &source, const OpcUa_Guid &copy)
 Copy OpcUa_VariableTypeAttributes data to an existing OpcUa_VariableTypeAttributes structure. More...
 

Friends

UABASE_EXPORT UaDataStream & operator<< (UaDataStream &, const UaGuid &)
 Writes the internal guid value to the stream.
 
UABASE_EXPORT UaDataStream & operator>> (UaDataStream &, UaGuid &)
 Reads a guid value from the stream.
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_Guid.

Helper class for handling the OPC UA built-in data type Guid. It provides conversion and comparison functions and allows creation of a Guid.

Using Globally Unique IDentifiers (GUID) is a standard way to globally identify entities in a distributed computing environment. It is a 128-bit value.

Constructor & Destructor Documentation

UaGuid::UaGuid ( const UaGuid other)

construction

Parameters
otherthe UaGuid.
UaGuid::UaGuid ( const OpcUa_Guid other)

construction

Parameters
otherthe OpcUa_Guid.

Member Function Documentation

void UaGuid::clear ( )

Clear the data of the UaGuid.

OpcUa_Guid * UaGuid::clone ( const OpcUa_Guid source)
static

Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes.

Parameters
sourceSource to clone.
Returns
new copy.
void UaGuid::cloneTo ( const OpcUa_Guid source,
const OpcUa_Guid copy 
)
static

Copy OpcUa_VariableTypeAttributes data to an existing OpcUa_VariableTypeAttributes structure.

Parameters
sourceSource OpcUa_VariableTypeAttributes to clone.
copyNew copy of source OpcUa_VariableTypeAttributes.
bool UaGuid::compare ( const OpcUa_Guid guid1,
const OpcUa_Guid guid2 
)
static

Compares the value of two structures.

Parameters
guid1the guid to compare.
guid2the guid to compare.
Returns
true if it is NULL false if not.
OpcUa_Guid * UaGuid::copy ( ) const

Copy Guid to a newly allocated OpcUa_Guid.

Returns
a newly allocated OpcUa_Guid.
void UaGuid::copyTo ( OpcUa_Guid pDst) const

Copy Guid data to an existing OpcUa_Guid structure.

Parameters
pDstthe destination of the copy operation.
UaGuid UaGuid::create ( )
static

Create a new GUID.

Returns
a new GUID
OpcUa_StatusCode UaGuid::fromString ( const UaString sGuid)

Converts a UTF-8 string representation of a GUID to a binary representation.

Parameters
sGuidthe guid as string.
Returns
a UTF-8 string representation of a GUID to a binary representation.
bool UaGuid::isNull ( ) const

Compares the value of two structures.

Returns
true if it is NULL false if not.
UaGuid::operator const OpcUa_Guid * ( ) const

Return internal OpcUa_UaGuid structure.

Returns
internal OpcUa_UaGuid structure.
bool UaGuid::operator!= ( const UaGuid other) const

Returns true if other is not equal to this.

See also
operator==
Parameters
otherthe UaString to compare.
Returns
true if other is not equal to this.
bool UaGuid::operator< ( const UaGuid other) const

Is lower than operator.

This is used to sort Guids e.g. to use it as key in map

Parameters
otherthe UaGuid to compare.
Returns
true if lower false if not.
UaGuid & UaGuid::operator= ( const UaGuid other)

Assignment operator.

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

Compare variables if they are similar.

Parameters
otherthe char to compare.
Returns
true if not similar false if similar.
bool UaGuid::operator> ( const UaGuid other) const

Is greater than operator.

Parameters
otherthe UaGuid to compare.
Returns
true if greater false if not.
UaString UaGuid::toString ( ) const

Converts the GUID to a string.

Returns
the GUID to a string.

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