C++ UA Server SDK
1.5.2.336
|
The class describes an Enumeration. More...
#include <uaenumdefinition.h>
Public Member Functions | |
UaEnumDefinition () | |
Creates an instance. More... | |
UaEnumDefinition (const UaEnumDefinition &other) | |
Copies the UaEnumDefinition including all enum values. More... | |
UaEnumDefinition & | operator= (const UaEnumDefinition &other) |
Assignment operator. | |
void | clear () |
Clears the UaEnumDefinition including all enum values. More... | |
bool | isNull () const |
Checks if the dataType is null. More... | |
void | setDataTypeId (const UaNodeId &nodeId) |
Sets the DataTypeId of the UaEnumDefinition. More... | |
UaNodeId | dataTypeId () const |
Returns the DataTypeId of the UaEnumDefinition. More... | |
void | setName (const UaString &sName) |
Sets the name of the UaEnumDefinition. More... | |
UaString | name () const |
Returns the name of the UaEnumDefinition. More... | |
void | setDocumentation (const UaLocalizedText &documentation) |
Sets the documentation of the UaEnumDefinition. More... | |
UaLocalizedText | documentation () const |
Returns the documentation of the UaEnumDefinition. More... | |
void | setNamespace (const UaString &sNamespace) |
Sets the NamespaceUri of the UaEnumDefinition. More... | |
UaString | getNamespace () const |
Returns the NamespaceUri of the UaEnumDefinition. More... | |
int | childrenCount () const |
Returns the number of enum values that are defined for the instance. More... | |
UaEnumValue | child (int i) const |
Returns the EnumValue at position i. More... | |
void | addChild (const UaEnumValue &newChild) |
Adds a new child. More... | |
UaEnumValue | enumValue (int iValue) const |
Returns the EnumValue with value iValue. More... | |
The class describes an Enumeration.
You can access the EnumValues by index or by value.
Enumerated DataTypes that are not known at compile time can be described using this class. This class can be used to add an enumerated DataType on server side as well as as result of reading the DataType Dictionary of a server on client side.
Each UaStructureDefinition is described by its name, its DataTypeId, the encoding Ids and a list of UaStructureFields.
UaEnumDefinition::UaEnumDefinition | ( | void | ) |
Creates an instance.
UaEnumDefinition::UaEnumDefinition | ( | const UaEnumDefinition & | other | ) |
Copies the UaEnumDefinition including all enum values.
void UaEnumDefinition::addChild | ( | const UaEnumValue & | newChild | ) |
Adds a new child.
The children are sorted by value.
UaEnumValue UaEnumDefinition::child | ( | int | i | ) | const |
Returns the EnumValue at position i.
int UaEnumDefinition::childrenCount | ( | ) | const |
Returns the number of enum values that are defined for the instance.
void UaEnumDefinition::clear | ( | ) |
Clears the UaEnumDefinition including all enum values.
UaNodeId UaEnumDefinition::dataTypeId | ( | ) | const |
Returns the DataTypeId of the UaEnumDefinition.
UaLocalizedText UaEnumDefinition::documentation | ( | ) | const |
Returns the documentation of the UaEnumDefinition.
UaEnumValue UaEnumDefinition::enumValue | ( | int | iValue | ) | const |
Returns the EnumValue with value iValue.
If the EnumDefinition does not contain an EnumValue with value iValue, an empty UaEnumValue is returned.
UaString UaEnumDefinition::getNamespace | ( | ) | const |
Returns the NamespaceUri of the UaEnumDefinition.
bool UaEnumDefinition::isNull | ( | ) | const |
Checks if the dataType is null.
UaString UaEnumDefinition::name | ( | ) | const |
Returns the name of the UaEnumDefinition.
void UaEnumDefinition::setDataTypeId | ( | const UaNodeId & | nodeId | ) |
Sets the DataTypeId of the UaEnumDefinition.
void UaEnumDefinition::setDocumentation | ( | const UaLocalizedText & | documentation | ) |
Sets the documentation of the UaEnumDefinition.
void UaEnumDefinition::setName | ( | const UaString & | sName | ) |
Sets the name of the UaEnumDefinition.
void UaEnumDefinition::setNamespace | ( | const UaString & | sNamespace | ) |
Sets the NamespaceUri of the UaEnumDefinition.