High Performance OPC UA Server SDK  1.2.0.193
ua_monitoreditemcreaterequest Struct Reference

A structure that is defined as the type of the itemsToCreate parameter of the CreateMonitoredItems service. More...

#include <monitoreditemcreaterequest.h>

Data Fields

struct ua_readvalueid item_to_monitor
 Identifies an item in the AddressSpace to monitor. More...
 
enum ua_monitoringmode monitoring_mode
 The monitoring mode to be set for the MonitoredItem.
 
struct ua_monitoringparameters requested_parameters
 The requested monitoring parameters. More...
 

Related Functions

void ua_monitoreditemcreaterequest_init (struct ua_monitoreditemcreaterequest *t)
 Initialize an ua_monitoreditemcreaterequest struct with a valid value. More...
 
void ua_monitoreditemcreaterequest_clear (struct ua_monitoreditemcreaterequest *t)
 Clear all resources alloctated in an ua_monitoreditemcreaterequest struct. More...
 
int ua_monitoreditemcreaterequest_compare (const struct ua_monitoreditemcreaterequest *a, const struct ua_monitoreditemcreaterequest *b)
 Compare two ua_monitoreditemcreaterequest structs. More...
 
int ua_monitoreditemcreaterequest_copy (struct ua_monitoreditemcreaterequest *dst, const struct ua_monitoreditemcreaterequest *src)
 Create a copy of a ua_monitoreditemcreaterequest struct. More...
 

Detailed Description

A structure that is defined as the type of the itemsToCreate parameter of the CreateMonitoredItems service.

Friends And Related Function Documentation

void ua_monitoreditemcreaterequest_clear ( struct ua_monitoreditemcreaterequest t)
related

Clear all resources alloctated in an ua_monitoreditemcreaterequest struct.

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

int ua_monitoreditemcreaterequest_compare ( const struct ua_monitoreditemcreaterequest a,
const struct ua_monitoreditemcreaterequest b 
)
related

Compare two ua_monitoreditemcreaterequest structs.

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

int ua_monitoreditemcreaterequest_copy ( struct ua_monitoreditemcreaterequest dst,
const struct ua_monitoreditemcreaterequest src 
)
related

Create a copy of a ua_monitoreditemcreaterequest struct.

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

Initialize an ua_monitoreditemcreaterequest 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_monitoreditemcreaterequest struct can also be passed to ua_monitoreditemcreaterequest_compare, ua_monitoreditemcreaterequest_copy and ua_monitoreditemcreaterequest_clear. This function will always succeed as long as an ua_monitoreditemcreaterequest struct is passed to it.

Field Documentation

item_to_monitor

Identifies an item in the AddressSpace to monitor.

To monitor for Events, the attributeId element of the ReadValueId structure is the id of the EventNotifier Attribute.

requested_parameters

The requested monitoring parameters.

Servers negotiate the values of these parameters based on the Subscription and the capabilities of the Server.


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