High Performance OPC UA Server SDK  1.2.0.193
ua_nodetypedescription Struct Reference

A structure that is defined as the type of the nodeTypes parameter of the Query service. More...

#include <nodetypedescription.h>

Data Fields

struct ua_expandednodeid type_definition_node
 NodeId of the originating TypeDefinitionNode of the instances for which data is to be returned.
 
bool include_sub_types
 A flag that indicates whether the Server should include instances of subtypes of the TypeDefinitionNode in the list of instances of the node type.
 
struct ua_querydatadescriptiondata_to_return
 Specifies an attribute or reference from the originating typeDefinitionNode along a given relativePath for which to return data.
 
int32_t num_data_to_return
 Number of elements in ua_nodetypedescription::data_to_return.
 

Related Functions

void ua_nodetypedescription_init (struct ua_nodetypedescription *t)
 Initialize an ua_nodetypedescription struct with a valid value. More...
 
void ua_nodetypedescription_clear (struct ua_nodetypedescription *t)
 Clear all resources alloctated in an ua_nodetypedescription struct. More...
 
int ua_nodetypedescription_compare (const struct ua_nodetypedescription *a, const struct ua_nodetypedescription *b)
 Compare two ua_nodetypedescription structs. More...
 
int ua_nodetypedescription_copy (struct ua_nodetypedescription *dst, const struct ua_nodetypedescription *src)
 Create a copy of a ua_nodetypedescription struct. More...
 
static int ua_nodetypedescription_resize_data_to_return_array (struct ua_nodetypedescription *val, int32_t new_len)
 Resize the data_to_return array of a ua_nodetypedescription struct. More...
 

Detailed Description

A structure that is defined as the type of the nodeTypes parameter of the Query service.

Friends And Related Function Documentation

void ua_nodetypedescription_clear ( struct ua_nodetypedescription t)
related

Clear all resources alloctated in an ua_nodetypedescription struct.

Frees allocated memory like arrays and resets numeric values. The ua_nodetypedescription struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_nodetypedescription struct, that was validly decoded, initilized by ua_nodetypedescription_init or created with ua_nodetypedescription_copy.

int ua_nodetypedescription_compare ( const struct ua_nodetypedescription a,
const struct ua_nodetypedescription b 
)
related

Compare two ua_nodetypedescription structs.

Compares the content of the ua_nodetypedescription struct a to the content of the ua_nodetypedescription 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_nodetypedescription structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_nodetypedescription_copy ( struct ua_nodetypedescription dst,
const struct ua_nodetypedescription src 
)
related

Create a copy of a ua_nodetypedescription struct.

Copy all fields from struct ua_nodetypedescription 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.

Returns
Zero on success or ua_statuscode on failure.
void ua_nodetypedescription_init ( struct ua_nodetypedescription t)
related

Initialize an ua_nodetypedescription 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_nodetypedescription struct can also be passed to ua_nodetypedescription_compare, ua_nodetypedescription_copy and ua_nodetypedescription_clear. This function will always succeed as long as an ua_nodetypedescription struct is passed to it.

static int ua_nodetypedescription_resize_data_to_return_array ( struct ua_nodetypedescription val,
int32_t  new_len 
)
related

Resize the data_to_return array of a ua_nodetypedescription struct.

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters
new_lenNew length of the data_to_return array in number of members.
Returns
Zero on success or ua_statuscode on failure.

The documentation for this struct was generated from the following files: