High Performance OPC UA Server SDK  1.2.0.193
ua_attributeoperand Struct Reference

Attribute of a node in the address space. More...

#include <attributeoperand.h>

Data Fields

struct ua_nodeid node_id
 NodeId of a Node from the type system.
 
struct ua_string alias
 An optional parameter used to identify or refer to an alias. More...
 
struct ua_relativepath browse_path
 Browse path relative to the node identified by the nodeId parameter.
 
uint32_t attribute_id
 ID of the attribute. More...
 
struct ua_string index_range
 This parameter is used to identify a single element of an array or a single range of indexes for an array. More...
 

Related Functions

void ua_attributeoperand_init (struct ua_attributeoperand *t)
 Initialize an ua_attributeoperand struct with a valid value. More...
 
void ua_attributeoperand_clear (struct ua_attributeoperand *t)
 Clear all resources alloctated in an ua_attributeoperand struct. More...
 
int ua_attributeoperand_compare (const struct ua_attributeoperand *a, const struct ua_attributeoperand *b)
 Compare two ua_attributeoperand structs. More...
 
int ua_attributeoperand_copy (struct ua_attributeoperand *dst, const struct ua_attributeoperand *src)
 Create a copy of a ua_attributeoperand struct. More...
 

Detailed Description

Attribute of a node in the address space.

Friends And Related Function Documentation

void ua_attributeoperand_clear ( struct ua_attributeoperand t)
related

Clear all resources alloctated in an ua_attributeoperand struct.

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

int ua_attributeoperand_compare ( const struct ua_attributeoperand a,
const struct ua_attributeoperand b 
)
related

Compare two ua_attributeoperand structs.

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

int ua_attributeoperand_copy ( struct ua_attributeoperand dst,
const struct ua_attributeoperand src 
)
related

Create a copy of a ua_attributeoperand struct.

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

Initialize an ua_attributeoperand 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_attributeoperand struct can also be passed to ua_attributeoperand_compare, ua_attributeoperand_copy and ua_attributeoperand_clear. This function will always succeed as long as an ua_attributeoperand struct is passed to it.

Field Documentation

alias

An optional parameter used to identify or refer to an alias.

An alias is a symbolic name that can be used to alias this operand and use it in other locations in the filter structure.

attribute_id

ID of the attribute.

This shall be a valid.

index_range

This parameter is used to identify a single element of an array or a single range of indexes for an array.

The first element is identified by index 0 (zero). This parameter is not used if the specified attribute is not an array. However, if the specified attribute is an array and this parameter is not used, then all elements are to be included in the range. The parameter is null if not used.


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