UaLocalizedText Class Reference [UA Base Library Classes]

Wrapper classs for the ua stack structure OpcUa_LocalizedText. More...

#include <ualocalizedtext.h>

List of all members.

Public Member Functions
	UaLocalizedText ()
	UaLocalizedText (const UaLocalizedText &other)
	UaLocalizedText (const OpcUa_LocalizedText &other)
	UaLocalizedText (const UaString &Locale, const UaString &Text)
	~UaLocalizedText ()
void	clear ()
void	detach ()
OpcUa_Boolean	isNull () const
UaLocalizedText &	operator= (const UaLocalizedText &other)
UaLocalizedText &	operator= (const OpcUa_LocalizedText &other)
bool	operator== (const UaLocalizedText &other) const
bool	operator!= (const UaLocalizedText &other) const
	operator const OpcUa_LocalizedText * () const
OpcUa_LocalizedText *	copy () const
void	copyTo (OpcUa_LocalizedText *pDst) const
UaString	toString () const
UaString	toFullString () const
void	setLocalizedText (const UaString &Locale, const UaString &Text)
void	setLocalizedText (const UaString &Text)
void	setText (const UaString &Text)
void	setLocale (const UaString &Locale)
const OpcUa_String *	locale () const
const OpcUa_String *	text () const
Static Public Member Functions
static bool	compare (const OpcUa_LocalizedText &, const OpcUa_LocalizedText &)
static OpcUa_LocalizedText *	clone (const OpcUa_LocalizedText &source)
static void	cloneTo (const OpcUa_LocalizedText &source, OpcUa_LocalizedText &copy)

---

Detailed Description

Wrapper classs for the ua stack structure OpcUa_LocalizedText.

---

Constructor & Destructor Documentation

UaLocalizedText::UaLocalizedText

(

)

construction

UaLocalizedText::UaLocalizedText

(

const UaLocalizedText &

other )

construction

Parameters:

other

the UaLocalizedText.

UaLocalizedText::UaLocalizedText

(

const OpcUa_LocalizedText &

other )

construction

Parameters:

other

the OpcUa_LocalizedText.

UaLocalizedText::UaLocalizedText	(	const UaString &	sLocale,
		const UaString &	sText
	)

construction

Parameters:

sLocale	the country id (e.g. "en").
sText	the text to write.

UaLocalizedText::~UaLocalizedText

(

)

destruction

---

Member Function Documentation

void UaLocalizedText::clear

(

)

Clear the data of the UaLocalizedText.

OpcUa_LocalizedText * UaLocalizedText::clone

(

const OpcUa_LocalizedText &

source )

[static]

Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes..

Parameters:

source

Source to clone.

Returns:

new copy.

void UaLocalizedText::cloneTo	(	const OpcUa_LocalizedText &	source,
		OpcUa_LocalizedText &	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.

bool UaLocalizedText::compare	(	const OpcUa_LocalizedText &	lText1,
		const OpcUa_LocalizedText &	lText2
	)		[static]

Compare two UaLocalizedText variables.

Parameters:

lText1	a value as UaLocalizedText.
lText2	a value as UaLocalizedText.

Returns:

true if equal false if not.

OpcUa_LocalizedText * UaLocalizedText::copy

(

)

const

Copy UaLocalizedText data to a newly allocated OpcUa_LocalizedText.

Returns:

a newly allocated OpcUa_LocalizedText.

void UaLocalizedText::copyTo

(

OpcUa_LocalizedText *

pDst )

const

Copy UaLocalizedText data to an exisitng OpcUa_LocalizedText structure.

Parameters:

pDst	the destination of this operation.

void UaLocalizedText::detach

(

)

Detach class from structure data.

OpcUa_Boolean UaLocalizedText::isNull

(

)

const

Checks if the localized text is null.

Returns:

true if NULL false if not.

const OpcUa_String* UaLocalizedText::locale

(

)

const [inline]

Get the locale string.

Returns:

the locale string.

UaLocalizedText::operator const OpcUa_LocalizedText *

(

)

const

Return internal OpcUa_LocalizedText structure.

Returns:

internal OpcUa_LocalizedText structure.

bool UaLocalizedText::operator!=

(

const UaLocalizedText &

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.

UaLocalizedText & UaLocalizedText::operator=

(

const UaLocalizedText &

other )

Assignment operator.

Parameters:

other

the UaLocalizedText to assign.

Returns:

Assignment operator.

UaLocalizedText & UaLocalizedText::operator=

(

const OpcUa_LocalizedText &

other )

Assignment operator.

Parameters:

other

the OpcUa_LocalizedText to assign.

Returns:

Assignment operator.

bool UaLocalizedText::operator==

(

const UaLocalizedText &

other )

const

Compare variables if they are similar.

Parameters:

other

the char to compare.

Returns:

true if not similar false if similar.

void UaLocalizedText::setLocale

(

const UaString &

sLocale )

Overwrites the locale part of the localized text with the passed locale string.

Parameters:

sLocale

The locale id (e.g. "en").

void UaLocalizedText::setLocalizedText

(

const UaString &

sText )

Clears the current localized text and sets the text part with the passed text string.

Parameters:

sText

The text to set.

void UaLocalizedText::setLocalizedText	(	const UaString &	sLocale,
		const UaString &	sText
	)

Clears the current localized text and sets the locale part with the passed locale string and the text part with the passed text string.

Parameters:

sLocale	The locale id (e.g. "en").
sText	The text to set.

void UaLocalizedText::setText

(

const UaString &

sText )

Overwrites the text part of the localized text with the passed text string.

Parameters:

sText

The text to set.

const OpcUa_String* UaLocalizedText::text

(

)

const [inline]

Get the text string.

Returns:

the text string.

UaString UaLocalizedText::toFullString

(

)

const

Converts the full LocalizedText into a UaString. The format of the string is
<locale><text>
with the fields

• <locale> The locale part of the LocalizedText.
• <text> Text part of the LocalizedText

  Returns:

  the converted string.

UaString UaLocalizedText::toString

(

)

const

Converts the text part of the LocalizedText into a UaString.

Returns:

the converted string.

---

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

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