UaGuid Class Reference
[UA Base Library Classes]

Wrapper classs for the ua stack structure OpcUa_Guid. Helper class for modifying UaGuid elements. The UaGuid class stores a Global Unique Identifier (GUID). Using Globally Unique IDentifiers is a standard way to globally identify entities in a distributed computing environment. Derived from OpcUa_Guid. More...

#include <uaguid.h>

List of all members.


Public Member Functions

 UaGuid ()
 UaGuid (const UaGuid &other)
 UaGuid (const OpcUa_Guid &other)
 ~UaGuid ()
void clear ()
UaGuidoperator= (const UaGuid &other)
bool operator== (const UaGuid &other) const
bool operator!= (const UaGuid &other) const
bool isNull () const
 operator const OpcUa_Guid * () const
OpcUa_Guid * copy () const
void copyTo (OpcUa_Guid *pDst) const
UaString toString () const
OpcUa_StatusCode fromString (const UaString &)

Static Public Member Functions

static UaGuid create ()
static bool compare (const OpcUa_Guid &, const OpcUa_Guid &)
static OpcUa_Guid * clone (const OpcUa_Guid &source)
static void cloneTo (const OpcUa_Guid &source, const OpcUa_Guid &copy)

Detailed Description

Wrapper classs for the ua stack structure OpcUa_Guid. Helper class for modifying UaGuid elements. The UaGuid class stores a Global Unique Identifier (GUID). Using Globally Unique IDentifiers is a standard way to globally identify entities in a distributed computing environment. Derived from OpcUa_Guid.

Constructor & Destructor Documentation

UaGuid::UaGuid (  ) 

construction

UaGuid::UaGuid ( const UaGuid other  ) 

construction

Parameters:
other the UaGuid.

UaGuid::UaGuid ( const OpcUa_Guid &  other  ) 

construction

Parameters:
other the OpcUa_Guid.

UaGuid::~UaGuid (  ) 

destruction


Member Function Documentation

void UaGuid::clear (  ) 

Clear the data of the UaGuid.

UaGuid & UaGuid::operator= ( const UaGuid other  ) 

Assignment operator.

Parameters:
other the UaGuid to assign.
Returns:
Assignment operator.

UaGuid UaGuid::create (  )  [static]

Create a new GUID

Returns:
a new GUID

bool UaGuid::operator== ( const UaGuid other  )  const

Compare variables if they are similar.

Parameters:
other the char to compare.
Returns:
true if not similar false if similar.

bool UaGuid::operator!= ( const UaGuid other  )  const

Returns true if other is not equal to this.

See also:
operator==
Parameters:
other the UaString to compare.
Returns:
true if other is not equal to this.

bool UaGuid::compare ( const OpcUa_Guid &  guid1,
const OpcUa_Guid &  guid2 
) [static]

Compares the value of two structures.

Parameters:
guid1 the guid to compare.
guid2 the guid to compare.
Returns:
true if it is NULL false if not.

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.

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 exisitng OpcUa_Guid structure.

Parameters:
pDst the destination of the copyoperation.

OpcUa_Guid * UaGuid::clone ( const OpcUa_Guid &  source  )  [static]

Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes..

Parameters:
source Source to clone.
Returns:
new copy.

void UaGuid::cloneTo ( const OpcUa_Guid &  source,
const OpcUa_Guid &  copy 
) [static]

Copy OpcUa_VariableTypeAttributes data to an exisitng OpcUa_VariableTypeAttributes structure.

Parameters:
source Source OpcUa_VariableTypeAttributes to clone.
copy New copy of source OpcUa_VariableTypeAttributes.

UaString UaGuid::toString (  )  const

Converts the GUID to a string.

Returns:
the GUID to a string.

OpcUa_StatusCode UaGuid::fromString ( const UaString sGuid  ) 

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

Parameters:
sGuid the guid as string.
Returns:
a UTF-8 string representation of a GUID to a binary representation.


The documentation for this class was generated from the following files:
  • src/uabase/uabasecpp/uaguid.h
  • src/uabase/uabasecpp/uaguid.cpp