Wrapper classs for the ua stack structure OpcUa_LocalizedText.
More...
#include <ualocalizedtext.h>
List of all members.
Detailed Description
Wrapper classs for the ua stack structure OpcUa_LocalizedText.
Constructor & Destructor Documentation
UaLocalizedText::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 |
( |
|
) |
|
Member Function Documentation
void UaLocalizedText::clear |
( |
|
) |
|
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.
Assignment operator.
- Parameters:
-
- Returns:
- Assignment operator.
UaLocalizedText & UaLocalizedText::operator= |
( |
const OpcUa_LocalizedText & |
other |
) |
|
Assignment operator.
- Parameters:
-
| other | the OpcUa_LocalizedText to assign. |
- Returns:
- Assignment operator.
Compare variables if they are similar.
- Parameters:
-
| other | the char to compare. |
- Returns:
- true if not similar false if similar.
Returns true if other is not equal to this.
- See also:
- operator==
- Parameters:
-
- Returns:
- true if other is not equal to this.
bool UaLocalizedText::compare |
( |
const OpcUa_LocalizedText & |
lText1, |
|
|
const OpcUa_LocalizedText & |
lText2 | |
|
) |
| | [static] |
Compare two UaLocalizedText variables.
- Parameters:
-
- Returns:
- true if equal false if not.
UaLocalizedText::operator const OpcUa_LocalizedText * |
( |
|
) |
const |
Return internal OpcUa_LocalizedText structure.
- Returns:
- internal OpcUa_LocalizedText structure.
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. |
OpcUa_LocalizedText * UaLocalizedText::clone |
( |
const OpcUa_LocalizedText & |
source |
) |
[static] |
Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes..
- Parameters:
-
- 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. |
UaString UaLocalizedText::toString |
( |
|
) |
const |
Converts the text part of the LocalizedText into a UaString.
- Returns:
- the converted 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.
void UaLocalizedText::setLocalizedText |
( |
const UaString & |
sLocale, |
|
|
const UaString & |
sText | |
|
) |
| | |
Set the localized text.
- Parameters:
-
| sLocale | the country id (e.g. "en"). |
| sText | the text to write. |
void UaLocalizedText::setLocalizedText |
( |
const UaString & |
sText |
) |
|
const OpcUa_String* UaLocalizedText::locale |
( |
|
) |
const [inline] |
Get the locale string.
- Returns:
- the locale string.
const OpcUa_String* UaLocalizedText::text |
( |
|
) |
const [inline] |
Get the text string.
- Returns:
- the text string.
The documentation for this class was generated from the following files:
- src/uabase/uabasecpp/ualocalizedtext.h
- src/uabase/uabasecpp/ualocalizedtext.cpp