High Performance OPC UA Server SDK  1.2.0.193
ua_variabletypeattributes Struct Reference

The attributes for a variable type node. More...

#include <variabletypeattributes.h>

Data Fields

uint32_t specified_attributes
 
struct ua_localizedtext display_name
 
struct ua_localizedtext description
 
uint32_t write_mask
 
uint32_t user_write_mask
 
struct ua_variant value
 
struct ua_nodeid data_type
 
int32_t value_rank
 
uint32_t * array_dimensions
 
int32_t num_array_dimensions
 
bool is_abstract
 

Related Functions

void ua_variabletypeattributes_init (struct ua_variabletypeattributes *t)
 Initialize an ua_variabletypeattributes struct with a valid value. More...
 
void ua_variabletypeattributes_clear (struct ua_variabletypeattributes *t)
 Clear all resources alloctated in an ua_variabletypeattributes struct. More...
 
int ua_variabletypeattributes_compare (const struct ua_variabletypeattributes *a, const struct ua_variabletypeattributes *b)
 Compare two ua_variabletypeattributes structs. More...
 
int ua_variabletypeattributes_copy (struct ua_variabletypeattributes *dst, const struct ua_variabletypeattributes *src)
 Create a copy of a ua_variabletypeattributes struct. More...
 
static int ua_variabletypeattributes_resize_array_dimensions_array (struct ua_variabletypeattributes *val, int32_t new_len)
 Resize the array_dimensions array of a ua_variabletypeattributes struct. More...
 

Detailed Description

The attributes for a variable type node.

Friends And Related Function Documentation

void ua_variabletypeattributes_clear ( struct ua_variabletypeattributes t)
related

Clear all resources alloctated in an ua_variabletypeattributes struct.

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

int ua_variabletypeattributes_compare ( const struct ua_variabletypeattributes a,
const struct ua_variabletypeattributes b 
)
related

Compare two ua_variabletypeattributes structs.

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

int ua_variabletypeattributes_copy ( struct ua_variabletypeattributes dst,
const struct ua_variabletypeattributes src 
)
related

Create a copy of a ua_variabletypeattributes struct.

Copy all fields from struct ua_variabletypeattributes 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_variabletypeattributes_init ( struct ua_variabletypeattributes t)
related

Initialize an ua_variabletypeattributes 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_variabletypeattributes struct can also be passed to ua_variabletypeattributes_compare, ua_variabletypeattributes_copy and ua_variabletypeattributes_clear. This function will always succeed as long as an ua_variabletypeattributes struct is passed to it.

static int ua_variabletypeattributes_resize_array_dimensions_array ( struct ua_variabletypeattributes val,
int32_t  new_len 
)
related

Resize the array_dimensions array of a ua_variabletypeattributes 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 array_dimensions 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: