High Performance OPC UA Server SDK
1.2.0.193
|
A structure that is defined as the type of the dataToReturn parameter of the nodeTypes parameter of the Query service. More...
#include <querydatadescription.h>
Data Fields | |
struct ua_relativepath | relative_path |
Browse path relative to the originating node that identifies the node which contains the data that is being requested, where the originating node is an instance node of the type defined by the type definition node. More... | |
uint32_t | attribute_id |
The ID of the attribute. More... | |
struct ua_string | index_range |
Used to identify a single element of a structure or an array, or a single range of indexes for arrays. More... | |
Related Functions | |
void | ua_querydatadescription_init (struct ua_querydatadescription *t) |
Initialize an ua_querydatadescription struct with a valid value. More... | |
void | ua_querydatadescription_clear (struct ua_querydatadescription *t) |
Clear all resources alloctated in an ua_querydatadescription struct. More... | |
int | ua_querydatadescription_compare (const struct ua_querydatadescription *a, const struct ua_querydatadescription *b) |
Compare two ua_querydatadescription structs. More... | |
int | ua_querydatadescription_copy (struct ua_querydatadescription *dst, const struct ua_querydatadescription *src) |
Create a copy of a ua_querydatadescription struct. More... | |
A structure that is defined as the type of the dataToReturn parameter of the nodeTypes parameter of the Query service.
|
related |
Clear all resources alloctated in an ua_querydatadescription struct.
Frees allocated memory like arrays and resets numeric values. The ua_querydatadescription struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_querydatadescription struct, that was validly decoded, initilized by ua_querydatadescription_init or created with ua_querydatadescription_copy.
|
related |
Compare two ua_querydatadescription structs.
Compares the content of the ua_querydatadescription struct a
to the content of the ua_querydatadescription 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_querydatadescription 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_querydatadescription struct.
Copy all fields from struct ua_querydatadescription 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_querydatadescription 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_querydatadescription struct can also be passed to ua_querydatadescription_compare, ua_querydatadescription_copy and ua_querydatadescription_clear. This function will always succeed as long as an ua_querydatadescription struct is passed to it.
attribute_id |
The ID of the attribute.
This shall be a valid attribute ID. If the RelativePath ended in a reference, this parameter is 0 and ignored by the server.
index_range |
Used to identify a single element of a structure or an array, or a single range of indexes for arrays.
If a range of elements is specified, the values are returned as a composite. The first element is identified by index 0 (zero). This parameter is null if the specified attribute is not an array or a structure. However, if the specified attribute is an array or a structure and this parameter is null, all elements are to be included in the range.
relative_path |
Browse path relative to the originating node that identifies the node which contains the data that is being requested, where the originating node is an instance node of the type defined by the type definition node.
The instance nodes are further limited by the filter provided as part of this call.
This relative path could end on a reference, in which case the ReferenceDescription of the reference would be returned as its value.
The targetName field of the relativePath may contain a type NodeId. This is done by setting the namespaceIndex of the targetName to zero and the name part of the targetName to the XML representation of the NodeId.
When matching instances are returned as the target node, the target node shall be an instance of the specified type or subtype of the specified type.