High Performance OPC UA Server SDK  1.2.0.193
ua_addnodesitem Struct Reference

A structure that is defined as the type of the nodesToAdd parameter of the AddNodes Service. More...

#include <addnodesitem.h>

Data Fields

struct ua_expandednodeid parent_node_id
 ExpandedNodeId of the parent node for the reference.
 
struct ua_nodeid reference_type_id
 NodeId of the hierarchical ReferenceType to use for the reference from the parent node to the new node.
 
struct ua_expandednodeid requested_new_node_id
 Client requested expanded NodeId of the node to add. More...
 
struct ua_qualifiedname browse_name
 The browse name of the node to add.
 
enum ua_nodeclass node_class
 NodeClass of the node to add.
 
struct ua_extensionobject node_attributes
 The attributes that are specific to the NodeClass. More...
 
struct ua_expandednodeid type_definition
 NodeId of the TypeDefinitionNode for the node to add. More...
 

Related Functions

void ua_addnodesitem_init (struct ua_addnodesitem *t)
 Initialize an ua_addnodesitem struct with a valid value. More...
 
void ua_addnodesitem_clear (struct ua_addnodesitem *t)
 Clear all resources alloctated in an ua_addnodesitem struct. More...
 
int ua_addnodesitem_compare (const struct ua_addnodesitem *a, const struct ua_addnodesitem *b)
 Compare two ua_addnodesitem structs. More...
 
int ua_addnodesitem_copy (struct ua_addnodesitem *dst, const struct ua_addnodesitem *src)
 Create a copy of a ua_addnodesitem struct. More...
 

Detailed Description

A structure that is defined as the type of the nodesToAdd parameter of the AddNodes Service.

Friends And Related Function Documentation

void ua_addnodesitem_clear ( struct ua_addnodesitem t)
related

Clear all resources alloctated in an ua_addnodesitem struct.

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

int ua_addnodesitem_compare ( const struct ua_addnodesitem a,
const struct ua_addnodesitem b 
)
related

Compare two ua_addnodesitem structs.

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

int ua_addnodesitem_copy ( struct ua_addnodesitem dst,
const struct ua_addnodesitem src 
)
related

Create a copy of a ua_addnodesitem struct.

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

Initialize an ua_addnodesitem 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_addnodesitem struct can also be passed to ua_addnodesitem_compare, ua_addnodesitem_copy and ua_addnodesitem_clear. This function will always succeed as long as an ua_addnodesitem struct is passed to it.

Field Documentation

node_attributes

The attributes that are specific to the NodeClass.

A Client is allowed to omit values for some or all attributes. If an attribute value is omitted, the Server shall use the default values from the TypeDefinitionNode. If a TypeDefinitionNode was not provided, the Server shall choose a suitable default value.

The Server may still add an optional attribute to the node with an appropriate default value even if the Client does not specify a value.

requested_new_node_id

Client requested expanded NodeId of the node to add.

The server index in the expanded NodeId shall be 0.

If the Server cannot use this NodeId, it rejects this node and returns the appropriate error code.

If the Client does not want to request a NodeId, it sets the value of this parameter to the null expanded NodeId.

If the node to add is a ReferenceType node, its NodeId should be a numeric id. See Part 3 of the OPC UA specification for a description of ReferenceType NodeIds.

type_definition

NodeId of the TypeDefinitionNode for the node to add.

This parameter shall be null for all node classes other than object and Variable, in which case it shall be provided.


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