High Performance OPC UA Server SDK  1.2.0.193
ua_xvtype Struct Reference

Defines a physical value relative to a X axis and it is used as the DataType of the Value of XYArrayItemType. More...

#include <xvtype.h>

Data Fields

double x
 Position on the X axis of this value.
 
float value
 The value itself.
 

Related Functions

void ua_xvtype_init (struct ua_xvtype *t)
 Initialize an ua_xvtype struct with a valid value. More...
 
void ua_xvtype_clear (struct ua_xvtype *t)
 Clear all resources alloctated in an ua_xvtype struct. More...
 
int ua_xvtype_compare (const struct ua_xvtype *a, const struct ua_xvtype *b)
 Compare two ua_xvtype structs. More...
 
int ua_xvtype_copy (struct ua_xvtype *dst, const struct ua_xvtype *src)
 Create a copy of a ua_xvtype struct. More...
 

Detailed Description

Defines a physical value relative to a X axis and it is used as the DataType of the Value of XYArrayItemType.

Most analysers can produce values that can perfectly be represented with a float IEEE 32 bits, but they can position them on the X axis with an accuracy that requires double IEEE 64 bits. For example, the peak value in an absorbance spectrum where the amplitude of the peak can be represented by a float IEEE 32 bits, but its frequency position required 10 digits which implies the use of a double IEEE 64 bits.

Friends And Related Function Documentation

void ua_xvtype_clear ( struct ua_xvtype t)
related

Clear all resources alloctated in an ua_xvtype struct.

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

int ua_xvtype_compare ( const struct ua_xvtype a,
const struct ua_xvtype b 
)
related

Compare two ua_xvtype structs.

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

int ua_xvtype_copy ( struct ua_xvtype dst,
const struct ua_xvtype src 
)
related

Create a copy of a ua_xvtype struct.

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

Initialize an ua_xvtype 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_xvtype struct can also be passed to ua_xvtype_compare, ua_xvtype_copy and ua_xvtype_clear. This function will always succeed as long as an ua_xvtype struct is passed to it.


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