High Performance OPC UA Server SDK  1.2.0.193
ua_monitoreditemcreateresult Struct Reference

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

#include <monitoreditemcreateresult.h>

Data Fields

ua_statuscode status_code
 StatusCode for the MonitoredItem to create.
 
uint32_t monitored_item_id
 Server-assigned ID for the MonitoredItem. More...
 
double revised_sampling_interval
 The actual sampling interval that the Server will use. More...
 
uint32_t revised_queue_size
 The actual queue size that the Server will use.
 
struct ua_extensionobject filter_result
 Contains any revised parameter values or error results associated with the MonitoringFilter specified in the request. More...
 

Related Functions

void ua_monitoreditemcreateresult_init (struct ua_monitoreditemcreateresult *t)
 Initialize an ua_monitoreditemcreateresult struct with a valid value. More...
 
void ua_monitoreditemcreateresult_clear (struct ua_monitoreditemcreateresult *t)
 Clear all resources alloctated in an ua_monitoreditemcreateresult struct. More...
 
int ua_monitoreditemcreateresult_compare (const struct ua_monitoreditemcreateresult *a, const struct ua_monitoreditemcreateresult *b)
 Compare two ua_monitoreditemcreateresult structs. More...
 
int ua_monitoreditemcreateresult_copy (struct ua_monitoreditemcreateresult *dst, const struct ua_monitoreditemcreateresult *src)
 Create a copy of a ua_monitoreditemcreateresult struct. More...
 

Detailed Description

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

Friends And Related Function Documentation

void ua_monitoreditemcreateresult_clear ( struct ua_monitoreditemcreateresult t)
related

Clear all resources alloctated in an ua_monitoreditemcreateresult struct.

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

int ua_monitoreditemcreateresult_compare ( const struct ua_monitoreditemcreateresult a,
const struct ua_monitoreditemcreateresult b 
)
related

Compare two ua_monitoreditemcreateresult structs.

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

int ua_monitoreditemcreateresult_copy ( struct ua_monitoreditemcreateresult dst,
const struct ua_monitoreditemcreateresult src 
)
related

Create a copy of a ua_monitoreditemcreateresult struct.

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

Initialize an ua_monitoreditemcreateresult 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_monitoreditemcreateresult struct can also be passed to ua_monitoreditemcreateresult_compare, ua_monitoreditemcreateresult_copy and ua_monitoreditemcreateresult_clear. This function will always succeed as long as an ua_monitoreditemcreateresult struct is passed to it.

Field Documentation

filter_result

Contains any revised parameter values or error results associated with the MonitoringFilter specified in the request.

This parameter may be omitted if no errors occurred. The MonitoringFilterResult parameter type is an extensible parameter type.

monitored_item_id

Server-assigned ID for the MonitoredItem.

This ID is unique within the Subscription, but might not be unique within the Server or Session. This parameter is present only if the statusCode indicates that the MonitoredItem was successfully created.

revised_sampling_interval

The actual sampling interval that the Server will use.

This value is based on a number of factors, including capabilities of the underlying system. The Server shall always return a revisedSamplingInterval that is equal or higher than the requestedSamplingInterval. If the requested samplingInterval is higher than the maximum sampling interval supported by the Server, the maximum sampling interval is returned.


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