High Performance OPC UA Server SDK  1.1.0.158
ua_viewdescription Struct Reference

Specifies a View. More...

#include <viewdescription.h>

Data Fields

struct ua_nodeid view_id
 NodeId of the View to Query. More...
 
ua_datetime timestamp
 The time date desired. More...
 
uint32_t view_version
 The version number for the View desired. More...
 

Related Functions

void ua_viewdescription_init (struct ua_viewdescription *t)
 Initialize an ua_viewdescription struct with a valid value. More...
 
void ua_viewdescription_clear (struct ua_viewdescription *t)
 Clear all resources alloctated in an ua_viewdescription struct. More...
 
int ua_viewdescription_compare (const struct ua_viewdescription *a, const struct ua_viewdescription *b)
 Compare two ua_viewdescription structs. More...
 
int ua_viewdescription_copy (struct ua_viewdescription *dst, const struct ua_viewdescription *src)
 Create a copy of a ua_viewdescription struct. More...
 

Detailed Description

Specifies a View.

Friends And Related Function Documentation

void ua_viewdescription_clear ( struct ua_viewdescription t)
related

Clear all resources alloctated in an ua_viewdescription struct.

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

int ua_viewdescription_compare ( const struct ua_viewdescription a,
const struct ua_viewdescription b 
)
related

Compare two ua_viewdescription structs.

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

int ua_viewdescription_copy ( struct ua_viewdescription dst,
const struct ua_viewdescription src 
)
related

Create a copy of a ua_viewdescription struct.

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

Initialize an ua_viewdescription 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_viewdescription struct can also be passed to ua_viewdescription_compare, ua_viewdescription_copy and ua_viewdescription_clear. This function will always succeed as long as an ua_viewdescription struct is passed to it.

Field Documentation

timestamp

The time date desired.

The corresponding version is the one with the closest previous creation timestamp. Either the Timestamp or the viewVersion parameter may be set by a Client, but not both. If ViewVersion is set this parameter shall be null.

view_id

NodeId of the View to Query.

A null value indicates the entire AddressSpace.

view_version

The version number for the View desired.

When Nodes are added to or removed from a View, the value of a View’s ViewVersion Property is updated. Either the Timestamp or the viewVersion parameter may be set by a Client, but not both. The ViewVersion Property is defined in Part 3. If timestamp is set this parameter shall be 0. The current view is used if timestamp is null and viewVersion is 0.


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