High Performance OPC UA Server SDK  1.2.0.193
ua_historyevent Struct Reference

A table structure that is used to return Event fields to a Historical Read. More...

#include <historyevent.h>

Data Fields

struct ua_historyeventfieldlistevents
 The list of Events being delivered.
 
int32_t num_events
 Number of elements in ua_historyevent::events.
 

Related Functions

void ua_historyevent_init (struct ua_historyevent *t)
 Initialize an ua_historyevent struct with a valid value. More...
 
void ua_historyevent_clear (struct ua_historyevent *t)
 Clear all resources alloctated in an ua_historyevent struct. More...
 
int ua_historyevent_compare (const struct ua_historyevent *a, const struct ua_historyevent *b)
 Compare two ua_historyevent structs. More...
 
int ua_historyevent_copy (struct ua_historyevent *dst, const struct ua_historyevent *src)
 Create a copy of a ua_historyevent struct. More...
 
static int ua_historyevent_resize_events_array (struct ua_historyevent *val, int32_t new_len)
 Resize the events array of a ua_historyevent struct. More...
 

Detailed Description

A table structure that is used to return Event fields to a Historical Read.

The structure is in the form of a table consisting of one or more Events, each containing an array of one or more fields. The selection and order of the fields returned for each Event is identical to the selected parameter of the EventFilter.

Friends And Related Function Documentation

void ua_historyevent_clear ( struct ua_historyevent t)
related

Clear all resources alloctated in an ua_historyevent struct.

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

int ua_historyevent_compare ( const struct ua_historyevent a,
const struct ua_historyevent b 
)
related

Compare two ua_historyevent structs.

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

int ua_historyevent_copy ( struct ua_historyevent dst,
const struct ua_historyevent src 
)
related

Create a copy of a ua_historyevent struct.

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

Initialize an ua_historyevent 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_historyevent struct can also be passed to ua_historyevent_compare, ua_historyevent_copy and ua_historyevent_clear. This function will always succeed as long as an ua_historyevent struct is passed to it.

static int ua_historyevent_resize_events_array ( struct ua_historyevent val,
int32_t  new_len 
)
related

Resize the events array of a ua_historyevent 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 events 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: