 |
High Performance OPC UA Server SDK
1.2.0.193
|
|
High Performance OPC UA Server SDK
1.2.0.193
|
A mapping between a value of an enumerated type and a name and description. More...
#include <enumvaluetype.h>
Data Fields | |
| int64_t | value |
| The Integer representation of an Enumeration. | |
| struct ua_localizedtext | display_name |
| A human-readable representation of the Value of the Enumeration. | |
| struct ua_localizedtext | description |
| A localized description of the enumeration value. More... | |
Related Functions | |
| void | ua_enumvaluetype_init (struct ua_enumvaluetype *t) |
| Initialize an ua_enumvaluetype struct with a valid value. More... | |
| void | ua_enumvaluetype_clear (struct ua_enumvaluetype *t) |
| Clear all resources alloctated in an ua_enumvaluetype struct. More... | |
| int | ua_enumvaluetype_compare (const struct ua_enumvaluetype *a, const struct ua_enumvaluetype *b) |
| Compare two ua_enumvaluetype structs. More... | |
| int | ua_enumvaluetype_copy (struct ua_enumvaluetype *dst, const struct ua_enumvaluetype *src) |
| Create a copy of a ua_enumvaluetype struct. More... | |
A mapping between a value of an enumerated type and a name and description.
When this type is used in an array representing human readable representations of an enumeration, each Value shall be unique in that array.
|
related |
Clear all resources alloctated in an ua_enumvaluetype struct.
Frees allocated memory like arrays and resets numeric values. The ua_enumvaluetype struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_enumvaluetype struct, that was validly decoded, initilized by ua_enumvaluetype_init or created with ua_enumvaluetype_copy.
|
related |
Compare two ua_enumvaluetype structs.
Compares the content of the ua_enumvaluetype struct a to the content of the ua_enumvaluetype struct b. If a is smaller than b, an integer less than zero is returned, if a is bigger than b, an integer greater than zero is returned. If both structs are equal zero is returned.
This function creates a total order on ua_enumvaluetype structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.
|
related |
Create a copy of a ua_enumvaluetype struct.
Copy all fields from struct ua_enumvaluetype src to dst. Creates a deep copy so all content is recusively copied and both src and dst can be used and must be freed separately.
dst is not cleared before the copy operation, so it must not have any allocated data. It may or may not be initilized by the caller before copy.
|
related |
Initialize an ua_enumvaluetype struct with a valid value.
After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_enumvaluetype struct can also be passed to ua_enumvaluetype_compare, ua_enumvaluetype_copy and ua_enumvaluetype_clear. This function will always succeed as long as an ua_enumvaluetype struct is passed to it.
| description |
A localized description of the enumeration value.
This field can contain an empty string if no description is available.