UaQualifiedName Class Reference [UA Base Library Classes]

Wrapper classs for the ua stack structure OpcUa_QualifiedName. Qualified names are two-part names: namespaceindex (UInt16) and name (String). The name part of QualifiedNames is restricted to 512 characters. Derived from OpcUa_QualifiedName. More...

#include <uaqualifiedname.h>

List of all members.

Public Member Functions
	UaQualifiedName ()
	UaQualifiedName (const UaQualifiedName &other)
	UaQualifiedName (const OpcUa_QualifiedName &other)
	UaQualifiedName (const UaString &Name, OpcUa_UInt16 NameSpaceIdx)
	~UaQualifiedName ()
void	clear ()
void	detach ()
OpcUa_Boolean	isNull () const
UaQualifiedName &	operator= (const UaQualifiedName &other)
UaQualifiedName &	operator= (const OpcUa_QualifiedName &other)
bool	operator== (const UaQualifiedName &other) const
bool	operator!= (const UaQualifiedName &other) const
	operator const OpcUa_QualifiedName * () const
OpcUa_QualifiedName *	copy () const
void	copyTo (OpcUa_QualifiedName *pDst) const
UaString	toString () const
UaString	toFullString () const
void	setQualifiedName (const UaString &Name, OpcUa_UInt16 NameSpaceIdx)
Static Public Member Functions
static bool	compare (const OpcUa_QualifiedName &, const OpcUa_QualifiedName &)
static OpcUa_QualifiedName *	clone (const OpcUa_QualifiedName &source)
static void	cloneTo (const OpcUa_QualifiedName &source, OpcUa_QualifiedName &copy)

---

Detailed Description

Wrapper classs for the ua stack structure OpcUa_QualifiedName. Qualified names are two-part names: namespaceindex (UInt16) and name (String). The name part of QualifiedNames is restricted to 512 characters. Derived from OpcUa_QualifiedName.

---

Constructor & Destructor Documentation

UaQualifiedName::UaQualifiedName

(

)

construction

UaQualifiedName::UaQualifiedName

(

const UaQualifiedName &

other )

construction

Parameters:

other

the UaQualifiedName.

UaQualifiedName::UaQualifiedName

(

const OpcUa_QualifiedName &

other )

construction

Parameters:

other

the OpcUa_QualifiedName.

UaQualifiedName::UaQualifiedName	(	const UaString &	sName,
		OpcUa_UInt16	NameSpaceIdx
	)

construction

Parameters:

sName	the name as UaString.
NameSpaceIdx	the namespace index.

UaQualifiedName::~UaQualifiedName

(

)

destruction

---

Member Function Documentation

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:

source

Source to clone.

Returns:

new copy.

void UaQualifiedName::cloneTo	(	const OpcUa_QualifiedName &	source,
		OpcUa_QualifiedName &	copy
	)		[static]

Copy OpcUa_QualifiedName data to an exisitng OpcUa_QualifiedName structure

Parameters:

source	the OpcUa_QualifiedName source of the operation.
copy	the OpcUa_QualifiedName destination of the operation.

bool UaQualifiedName::compare	(	const OpcUa_QualifiedName &	qName1,
		const OpcUa_QualifiedName &	qName2
	)		[static]

Compare two UaQualifiedName variables.

Parameters:

qName1	a value as UaQualifiedName.
qName2	a 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 exisitng OpcUa_QualifiedName structure.

Parameters:

pDst	the destination of this copyoperation.

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:

other

the UaString to compare.

Returns:

true if other is not equal to this.

UaQualifiedName & UaQualifiedName::operator=

(

const UaQualifiedName &

other )

Assignment operator.

Parameters:

other

the UaQualifiedName to assign.

Returns:

Assignment operator..

UaQualifiedName & UaQualifiedName::operator=

(

const OpcUa_QualifiedName &

other )

Assignment operator.

Parameters:

other

the OpcUa_QualifiedName to assign.

Returns:

Assignment operator.

bool UaQualifiedName::operator==

(

const UaQualifiedName &

other )

const

Compare variables if they are similar.

Parameters:

other

the char to compare.

Returns:

true if not similar false if similar.

void UaQualifiedName::setQualifiedName	(	const UaString &	sName,
		OpcUa_UInt16	NameSpaceIdx
	)

Set the Qualified name.

Parameters:

sName	the name as UaString.
NameSpaceIdx	the 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> 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:

• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uaqualifiedname.h
• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uaqualifiedname.cpp