High Performance OPC UA Server SDK  1.2.0.193
ua_monitoreditemmodifyresult Struct Reference

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

#include <monitoreditemmodifyresult.h>

Data Fields

ua_statuscode status_code
 StatusCode for the MonitoredItem to be modified.
 
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_monitoreditemmodifyresult_init (struct ua_monitoreditemmodifyresult *t)
 Initialize an ua_monitoreditemmodifyresult struct with a valid value. More...
 
void ua_monitoreditemmodifyresult_clear (struct ua_monitoreditemmodifyresult *t)
 Clear all resources alloctated in an ua_monitoreditemmodifyresult struct. More...
 
int ua_monitoreditemmodifyresult_compare (const struct ua_monitoreditemmodifyresult *a, const struct ua_monitoreditemmodifyresult *b)
 Compare two ua_monitoreditemmodifyresult structs. More...
 
int ua_monitoreditemmodifyresult_copy (struct ua_monitoreditemmodifyresult *dst, const struct ua_monitoreditemmodifyresult *src)
 Create a copy of a ua_monitoreditemmodifyresult struct. More...
 

Detailed Description

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

Friends And Related Function Documentation

void ua_monitoreditemmodifyresult_clear ( struct ua_monitoreditemmodifyresult t)
related

Clear all resources alloctated in an ua_monitoreditemmodifyresult struct.

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

int ua_monitoreditemmodifyresult_compare ( const struct ua_monitoreditemmodifyresult a,
const struct ua_monitoreditemmodifyresult b 
)
related

Compare two ua_monitoreditemmodifyresult structs.

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

int ua_monitoreditemmodifyresult_copy ( struct ua_monitoreditemmodifyresult dst,
const struct ua_monitoreditemmodifyresult src 
)
related

Create a copy of a ua_monitoreditemmodifyresult struct.

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

Initialize an ua_monitoreditemmodifyresult 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_monitoreditemmodifyresult struct can also be passed to ua_monitoreditemmodifyresult_compare, ua_monitoreditemmodifyresult_copy and ua_monitoreditemmodifyresult_clear. This function will always succeed as long as an ua_monitoreditemmodifyresult 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.

revised_sampling_interval

The actual sampling interval that the Server will use.

The Server returns the value it will actually use for the sampling interval. 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 requested samplingInterval. If the requestedSamplingInterval 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: