 |
High Performance OPC UA Server SDK
1.2.0.193
|
|
High Performance OPC UA Server SDK
1.2.0.193
|
A structure that is defined as the type of the targets parameter of the results parameter of the TranslateBrowsePathsToNodeIds service. More...
#include <browsepathtarget.h>
Data Fields | |
| struct ua_expandednodeid | target_id |
| The identifier for a target of the RelativePath. | |
| uint32_t | remaining_path_index |
| The index of the first unprocessed element in the RelativePath. More... | |
Related Functions | |
| void | ua_browsepathtarget_init (struct ua_browsepathtarget *t) |
| Initialize an ua_browsepathtarget struct with a valid value. More... | |
| void | ua_browsepathtarget_clear (struct ua_browsepathtarget *t) |
| Clear all resources alloctated in an ua_browsepathtarget struct. More... | |
| int | ua_browsepathtarget_compare (const struct ua_browsepathtarget *a, const struct ua_browsepathtarget *b) |
| Compare two ua_browsepathtarget structs. More... | |
| int | ua_browsepathtarget_copy (struct ua_browsepathtarget *dst, const struct ua_browsepathtarget *src) |
| Create a copy of a ua_browsepathtarget struct. More... | |
A structure that is defined as the type of the targets parameter of the results parameter of the TranslateBrowsePathsToNodeIds service.
A Server may encounter a reference to a node in another Server which it cannot follow while it is processing the RelativePath. If this happens, the Server returns the NodeId of the external node and sets the remainingPathIndex parameter to indicate which RelativePath elements still need to be processed. To complete the operation the Client shall connect to the other Server and call this service again using the target as the startingNode and the unprocessed elements as the relativePath.
|
related |
Clear all resources alloctated in an ua_browsepathtarget struct.
Frees allocated memory like arrays and resets numeric values. The ua_browsepathtarget struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_browsepathtarget struct, that was validly decoded, initilized by ua_browsepathtarget_init or created with ua_browsepathtarget_copy.
|
related |
Compare two ua_browsepathtarget structs.
Compares the content of the ua_browsepathtarget struct a to the content of the ua_browsepathtarget 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_browsepathtarget 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_browsepathtarget struct.
Copy all fields from struct ua_browsepathtarget 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_browsepathtarget 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_browsepathtarget struct can also be passed to ua_browsepathtarget_compare, ua_browsepathtarget_copy and ua_browsepathtarget_clear. This function will always succeed as long as an ua_browsepathtarget struct is passed to it.
| remaining_path_index |
The index of the first unprocessed element in the RelativePath.
This value shall be equal to the maximum value of Index data type if all elements were processed.