High Performance OPC UA Server SDK  1.2.0.193
ua_contentfilterelement Struct Reference

A structure that is defined as the type of the elements parameter of the ContentFilter structure. More...

#include <contentfilterelement.h>

Data Fields

enum ua_filteroperator filter_operator
 Filter operator to be evaluated.
 
struct ua_extensionobjectfilter_operands
 Operands used by the selected operator. More...
 
int32_t num_filter_operands
 Number of elements in ua_contentfilterelement::filter_operands.
 

Related Functions

void ua_contentfilterelement_init (struct ua_contentfilterelement *t)
 Initialize an ua_contentfilterelement struct with a valid value. More...
 
void ua_contentfilterelement_clear (struct ua_contentfilterelement *t)
 Clear all resources alloctated in an ua_contentfilterelement struct. More...
 
int ua_contentfilterelement_compare (const struct ua_contentfilterelement *a, const struct ua_contentfilterelement *b)
 Compare two ua_contentfilterelement structs. More...
 
int ua_contentfilterelement_copy (struct ua_contentfilterelement *dst, const struct ua_contentfilterelement *src)
 Create a copy of a ua_contentfilterelement struct. More...
 
static int ua_contentfilterelement_resize_filter_operands_array (struct ua_contentfilterelement *val, int32_t new_len)
 Resize the filter_operands array of a ua_contentfilterelement struct. More...
 

Detailed Description

A structure that is defined as the type of the elements parameter of the ContentFilter structure.

Friends And Related Function Documentation

void ua_contentfilterelement_clear ( struct ua_contentfilterelement t)
related

Clear all resources alloctated in an ua_contentfilterelement struct.

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

int ua_contentfilterelement_compare ( const struct ua_contentfilterelement a,
const struct ua_contentfilterelement b 
)
related

Compare two ua_contentfilterelement structs.

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

int ua_contentfilterelement_copy ( struct ua_contentfilterelement dst,
const struct ua_contentfilterelement src 
)
related

Create a copy of a ua_contentfilterelement struct.

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

Initialize an ua_contentfilterelement 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_contentfilterelement struct can also be passed to ua_contentfilterelement_compare, ua_contentfilterelement_copy and ua_contentfilterelement_clear. This function will always succeed as long as an ua_contentfilterelement struct is passed to it.

static int ua_contentfilterelement_resize_filter_operands_array ( struct ua_contentfilterelement val,
int32_t  new_len 
)
related

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

Field Documentation

filter_operands

Operands used by the selected operator.

The number and use depend on the operators (see ua_filteroperator). This array needs at least one entry.


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