High Performance OPC UA Server SDK  1.2.0.193
ua_eventfilterresult Struct Reference

This is the MonitoringFilterResult associated with the EventFilter MonitoringFilter. More...

#include <eventfilterresult.h>

Data Fields

ua_statuscodeselect_clause_results
 List of status codes for the elements in the select clause. More...
 
int32_t num_select_clause_results
 Number of elements in ua_eventfilterresult::select_clause_results.
 
struct ua_diagnosticinfoselect_clause_diag_infos
 A list of diagnostic information for individual elements in the select clause. More...
 
int32_t num_select_clause_diag_infos
 Number of elements in ua_eventfilterresult::select_clause_diag_infos.
 
struct ua_contentfilterresult where_clause_result
 Any results associated with the whereClause request parameter.
 

Related Functions

void ua_eventfilterresult_init (struct ua_eventfilterresult *t)
 Initialize an ua_eventfilterresult struct with a valid value. More...
 
void ua_eventfilterresult_clear (struct ua_eventfilterresult *t)
 Clear all resources alloctated in an ua_eventfilterresult struct. More...
 
int ua_eventfilterresult_compare (const struct ua_eventfilterresult *a, const struct ua_eventfilterresult *b)
 Compare two ua_eventfilterresult structs. More...
 
int ua_eventfilterresult_copy (struct ua_eventfilterresult *dst, const struct ua_eventfilterresult *src)
 Create a copy of a ua_eventfilterresult struct. More...
 
static int ua_eventfilterresult_resize_select_clause_results_array (struct ua_eventfilterresult *val, int32_t new_len)
 Resize the select_clause_results array of a ua_eventfilterresult struct. More...
 
static int ua_eventfilterresult_resize_select_clause_diag_infos_array (struct ua_eventfilterresult *val, int32_t new_len)
 Resize the select_clause_diag_infos array of a ua_eventfilterresult struct. More...
 

Detailed Description

This is the MonitoringFilterResult associated with the EventFilter MonitoringFilter.

Friends And Related Function Documentation

void ua_eventfilterresult_clear ( struct ua_eventfilterresult t)
related

Clear all resources alloctated in an ua_eventfilterresult struct.

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

int ua_eventfilterresult_compare ( const struct ua_eventfilterresult a,
const struct ua_eventfilterresult b 
)
related

Compare two ua_eventfilterresult structs.

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

int ua_eventfilterresult_copy ( struct ua_eventfilterresult dst,
const struct ua_eventfilterresult src 
)
related

Create a copy of a ua_eventfilterresult struct.

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

Initialize an ua_eventfilterresult 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_eventfilterresult struct can also be passed to ua_eventfilterresult_compare, ua_eventfilterresult_copy and ua_eventfilterresult_clear. This function will always succeed as long as an ua_eventfilterresult struct is passed to it.

static int ua_eventfilterresult_resize_select_clause_diag_infos_array ( struct ua_eventfilterresult val,
int32_t  new_len 
)
related

Resize the select_clause_diag_infos array of a ua_eventfilterresult 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 select_clause_diag_infos array in number of members.
Returns
Zero on success or ua_statuscode on failure.
static int ua_eventfilterresult_resize_select_clause_results_array ( struct ua_eventfilterresult val,
int32_t  new_len 
)
related

Resize the select_clause_results array of a ua_eventfilterresult 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 select_clause_results array in number of members.
Returns
Zero on success or ua_statuscode on failure.

Field Documentation

select_clause_diag_infos

A list of diagnostic information for individual elements in the select clause.

The size and order of the list matches the size and order of the elements in the selectClauses request parameter. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the select clauses.

select_clause_results

List of status codes for the elements in the select clause.

The size and order of the list matches the size and order of the elements in the selectClauses request parameter. The Server returns null for unavailable or rejected Event fields.


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