.NET Based OPC UA Client/Server SDK  2.6.1.422
UnifiedAutomation.UaBase.BrowseRequest Class Reference

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

Public Member Functions

 BrowseRequest ()
 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]
 
ViewDescription View [get, set]
 Description of the View to browse. More...
 
uint RequestedMaxReferencesPerNode [get, set]
 Indicates the maximum number of references to return for each starting Node specified in the request. More...
 
BrowseDescriptionCollection NodesToBrowse [get, set]
 A list of nodes to Browse 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

The Browse service is used by a client to navigate through the address space by passing a starting node and browse filters. The server returns the list of referenced nodes matching the filter criteria.

The Browse service takes a list of starting nodes and returns a list of connected nodes for each starting node. Nevertheless, most clients will only pass one starting node for the main purpose of building a tree hierarchy. Since the OPC UA address space can be a full-meshed network and is not limited to a pure hierarchy, the capability to pass in a list of starting nodes is mainly used to browse metadata like the properties of a list of variables.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.BrowseRequest.BrowseRequest ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.BrowseRequest.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

BrowseDescriptionCollection UnifiedAutomation.UaBase.BrowseRequest.NodesToBrowse
getset

A list of nodes to Browse

uint UnifiedAutomation.UaBase.BrowseRequest.RequestedMaxReferencesPerNode
getset

Indicates the maximum number of references to return for each starting Node specified in the request.

The value 0 indicates that the Client is imposing no limitation.

RequestHeader UnifiedAutomation.UaBase.BrowseRequest.RequestHeader
getset

ViewDescription UnifiedAutomation.UaBase.BrowseRequest.View
getset

Description of the View to browse.

An empty ViewDescription value indicates the entire address space. If ViewDescription is empty, all references of the node to browse are returned. If any other view is specified, only the references of the node to browse that are defined for that view are returned.


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