Asynchronously translates a browse path to a NodeId. More...

#include <translatebrowsepathstonodeidsrequest.h>

Data Fields
struct ua_browsepath *	browse_paths
	A list of browse paths for which NodeIds are being requested.

int32_t	num_browse_paths
	Number of elements in ua_translatebrowsepathstonodeidsrequest::browse_paths.

Related Functions
void	ua_translatebrowsepathstonodeidsrequest_init (struct ua_translatebrowsepathstonodeidsrequest *t)
	Initialize an ua_translatebrowsepathstonodeidsrequest struct with a valid value. More...

void	ua_translatebrowsepathstonodeidsrequest_clear (struct ua_translatebrowsepathstonodeidsrequest *t)
	Clear all resources alloctated in an ua_translatebrowsepathstonodeidsrequest struct. More...

int	ua_translatebrowsepathstonodeidsrequest_compare (const struct ua_translatebrowsepathstonodeidsrequest a, const struct ua_translatebrowsepathstonodeidsrequest b)
	Compare two ua_translatebrowsepathstonodeidsrequest structs. More...

int	ua_translatebrowsepathstonodeidsrequest_copy (struct ua_translatebrowsepathstonodeidsrequest dst, const struct ua_translatebrowsepathstonodeidsrequest src)
	Create a copy of a ua_translatebrowsepathstonodeidsrequest struct. More...

static int	ua_translatebrowsepathstonodeidsrequest_resize_browse_paths_array (struct ua_translatebrowsepathstonodeidsrequest *val, int32_t new_len)
	Resize the browse_paths array of a ua_translatebrowsepathstonodeidsrequest struct. More...

Detailed Description

Asynchronously translates a browse path to a NodeId.

This service is used to request that the Server translates one or more browse paths to NodeIds. Each browse path is constructed of a starting node and a RelativePath. The specified starting Node identifies the node from which the RelativePath is based. The RelativePath contains a sequence of ReferenceTypes and BrowseNames.

One purpose of this service is to allow programming against type definitions. Since BrowseNames shall be unique in the context of type definitions, a Client may create a browse path that is valid for a type definition and use this path on instances of the type. For example, an ObjectType “Boiler” may have a “HeatSensor” Variable as InstanceDeclaration. A graphical element programmed against the “Boiler” may need to display the Value of the “HeatSensor”. If the graphical element would be called on “Boiler1”, an instance of “Boiler”, it would need to call this Service specifying the NodeId of “Boiler1” as starting node and the BrowseName of the “HeatSensor” as browse path. The Service would return the NodeId of the “HeatSensor” of “Boiler1” and the graphical element could subscribe to its Value attribute.

If a node has multiple targets with the same BrowseName, the Server shall return a list of NodeIds. However, since one of the main purposes of this service is to support programming against type definitions, the NodeId of the node based on the type definition of the starting node is returned as the first NodeId in the list.

Friends And Related Function Documentation

void ua_translatebrowsepathstonodeidsrequest_clear ( struct ua_translatebrowsepathstonodeidsrequest * t )

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

int ua_translatebrowsepathstonodeidsrequest_compare	(	const struct ua_translatebrowsepathstonodeidsrequest *	a,
		const struct ua_translatebrowsepathstonodeidsrequest *	b
	)

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

int ua_translatebrowsepathstonodeidsrequest_copy	(	struct ua_translatebrowsepathstonodeidsrequest *	dst,
		const struct ua_translatebrowsepathstonodeidsrequest *	src
	)

Copy all fields from struct ua_translatebrowsepathstonodeidsrequest 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_translatebrowsepathstonodeidsrequest_init ( struct ua_translatebrowsepathstonodeidsrequest * t )

After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_translatebrowsepathstonodeidsrequest struct can also be passed to ua_translatebrowsepathstonodeidsrequest_clear. This function will always succeed as long as an ua_translatebrowsepathstonodeidsrequest struct is passed to it.

static int ua_translatebrowsepathstonodeidsrequest_resize_browse_paths_array	(	struct ua_translatebrowsepathstonodeidsrequest *	val,
		int32_t	new_len
	)

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters

new_len New length of the browse_paths array in number of members.

Returns: Zero on success or ua_statuscode on failure.

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

C:/work/embeddedstack/src/uabase/service/translatebrowsepathstonodeidsrequest.h
C:/work/embeddedstack/src/uabase/service/translatebrowsepathstonodeidsrequest.c

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation