.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaBase.TranslateBrowsePathsToNodeIdsRequest Class Reference

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

Inherits UnifiedAutomation.UaBase.IServiceRequest, and UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 TranslateBrowsePathsToNodeIdsRequest ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
virtual void Decode (IDecoder decoder)
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 

Properties

RequestHeader RequestHeader [get, set]
 
BrowsePathCollection BrowsePaths [get, set]
 A list of browse paths for which NodeIds are being requested. More...
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
- Properties inherited from UnifiedAutomation.UaBase.IServiceRequest
RequestHeader RequestHeader [get, set]
 The header for the request. More...
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. 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.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.TranslateBrowsePathsToNodeIdsRequest.TranslateBrowsePathsToNodeIdsRequest ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.TranslateBrowsePathsToNodeIdsRequest.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

Property Documentation

BrowsePathCollection UnifiedAutomation.UaBase.TranslateBrowsePathsToNodeIdsRequest.BrowsePaths
getset

A list of browse paths for which NodeIds are being requested.

RequestHeader UnifiedAutomation.UaBase.TranslateBrowsePathsToNodeIdsRequest.RequestHeader
getset


The documentation for this class was generated from the following file: