C++ Based OPC UA Client/Server SDK  1.5.5.355

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

#include <uaqualifiedname.h>

Inherits OpcUa_QualifiedName.

Public Member Functions

 UaQualifiedName ()
 construction
 
 UaQualifiedName (const UaQualifiedName &other)
 construction More...
 
 UaQualifiedName (const OpcUa_QualifiedName &other)
 construction More...
 
 UaQualifiedName (const UaString &sName, OpcUa_UInt16 nameSpaceIdx)
 construction More...
 
 ~UaQualifiedName ()
 destruction
 
void clear ()
 Clear the data of the UaQualifiedName. More...
 
void detach ()
 Detach class from structure data. More...
 
UaQualifiedNameattach (const OpcUa_QualifiedName *pSrc)
 Attaches an existing OpcUa_QualifiedName structure. More...
 
OpcUa_Boolean isNull () const
 Checks if the qualified name is null. More...
 
UaQualifiedNameoperator= (const UaQualifiedName &other)
 Assignment operator. More...
 
UaQualifiedNameoperator= (const OpcUa_QualifiedName &other)
 Assignment operator. More...
 
bool operator== (const UaQualifiedName &other) const
 Compare variables if they are similar. More...
 
bool operator!= (const UaQualifiedName &other) const
 Returns true if other is not equal to this. More...
 
bool operator< (const UaQualifiedName &other) const
 Is lower than operator. More...
 
 operator const OpcUa_QualifiedName * () const
 Return internal OpcUa_QualifiedName structure. More...
 
OpcUa_QualifiedNamecopy () const
 Copy UaQualifiedName data to a newly allocated OpcUa_QualifiedName. More...
 
void copyTo (OpcUa_QualifiedName *pDst) const
 Copy UaQualifiedName data to an existing OpcUa_QualifiedName structure. More...
 
UaString toString () const
 Converts the name part of the QualifiedName into a UaString. More...
 
UaString toFullString () const
 Converts the full QualifiedName into a UaString. More...
 
void setQualifiedName (const UaString &sName, OpcUa_UInt16 nameSpaceIdx)
 Set the Qualified name. More...
 
void setNamespaceIndex (OpcUa_UInt16 namespaceIndex)
 Set the NamespaceIndex of the Qualified name. More...
 

Static Public Member Functions

static bool compare (const OpcUa_QualifiedName &, const OpcUa_QualifiedName &)
 Compare two UaQualifiedName variables. More...
 
static OpcUa_QualifiedNameclone (const OpcUa_QualifiedName &source)
 Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes. More...
 
static void cloneTo (const OpcUa_QualifiedName &source, OpcUa_QualifiedName &copy)
 Copy OpcUa_QualifiedName data to an existing OpcUa_QualifiedName structure. More...
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_QualifiedName.

Qualified names are two-part names: namespace index (UInt16) and name (String). The name part of QualifiedNames is restricted to 512 characters. Derived from OpcUa_QualifiedName.

Constructor & Destructor Documentation

UaQualifiedName::UaQualifiedName ( const UaQualifiedName other)

construction

Parameters
otherthe UaQualifiedName.
UaQualifiedName::UaQualifiedName ( const OpcUa_QualifiedName other)

construction

Parameters
otherthe OpcUa_QualifiedName.
UaQualifiedName::UaQualifiedName ( const UaString sName,
OpcUa_UInt16  nameSpaceIdx 
)

construction

Parameters
sNamethe name as UaString.
nameSpaceIdxthe namespace index.

Member Function Documentation

UaQualifiedName & UaQualifiedName::attach ( const OpcUa_QualifiedName pSrc)

Attaches an existing OpcUa_QualifiedName structure.

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

Parameters
pSrc[in] Parameter to attach.
void UaQualifiedName::clear ( )

Clear the data of the UaQualifiedName.

OpcUa_QualifiedName * UaQualifiedName::clone ( const OpcUa_QualifiedName source)
static

Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes.

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

Copy OpcUa_QualifiedName data to an existing OpcUa_QualifiedName structure.

Parameters
sourcethe OpcUa_QualifiedName source of the operation.
copythe OpcUa_QualifiedName destination of the operation.
bool UaQualifiedName::compare ( const OpcUa_QualifiedName qName1,
const OpcUa_QualifiedName qName2 
)
static

Compare two UaQualifiedName variables.

Parameters
qName1a value as UaQualifiedName.
qName2a value as UaQualifiedName.
Returns
true if equal false if not.
OpcUa_QualifiedName * UaQualifiedName::copy ( ) const

Copy UaQualifiedName data to a newly allocated OpcUa_QualifiedName.

Returns
new copy.
void UaQualifiedName::copyTo ( OpcUa_QualifiedName pDst) const

Copy UaQualifiedName data to an existing OpcUa_QualifiedName structure.

Parameters
pDstthe destination of this copy operation.
void UaQualifiedName::detach ( )

Detach class from structure data.

OpcUa_Boolean UaQualifiedName::isNull ( ) const

Checks if the qualified name is null.

Returns
true if null false if not.
UaQualifiedName::operator const OpcUa_QualifiedName * ( ) const

Return internal OpcUa_QualifiedName structure.

Returns
internal OpcUa_QualifiedName structure.
bool UaQualifiedName::operator!= ( const UaQualifiedName 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 UaQualifiedName::operator< ( const UaQualifiedName other) const

Is lower than operator.

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

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

Assignment operator.

Parameters
otherthe UaQualifiedName to assign.
Returns
Assignment operator..
UaQualifiedName & UaQualifiedName::operator= ( const OpcUa_QualifiedName other)

Assignment operator.

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

Compare variables if they are similar.

Parameters
otherthe char to compare.
Returns
true if not similar false if similar.
void UaQualifiedName::setNamespaceIndex ( OpcUa_UInt16  namespaceIndex)

Set the NamespaceIndex of the Qualified name.

Parameters
namespaceIndexthe NamespaceIndex.
void UaQualifiedName::setQualifiedName ( const UaString sName,
OpcUa_UInt16  nameSpaceIdx 
)

Set the Qualified name.

Parameters
sNamethe name as UaString.
nameSpaceIdxthe NamespaceIndex.
UaString UaQualifiedName::toFullString ( ) const

Converts the full QualifiedName into a UaString.

The format of the string is
ns=<namespaceindex>|<name>

with the fields

<namespaceindex>
The namespace index formatted as a base 10 number.
<name>
The name part of the QualifiedName.
Returns
the converted UaQualifiedName.
UaString UaQualifiedName::toString ( ) const

Converts the name part of the QualifiedName into a UaString.

Returns
the converted UaQualifiedName.

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