.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaClient.BrowseContext Class Reference

The context for a browse operation. More...

Public Member Functions

 BrowseContext ()
 Initializes a new instance of the BrowseContext class. More...
 

Properties

ViewDescription View [get, set]
 Description of the View to browse. More...
 
uint MaxReferencesToReturn [get, set]
 Indicates the maximum number of references to return for each starting Node specified in the request. More...
 
BrowseDirection BrowseDirection [get, set]
 Gets or sets the browse direction. More...
 
NodeId ReferenceTypeId [get, set]
 Specifies the NodeId of the ReferenceType to follow. More...
 
bool IncludeSubtypes [get, set]
 Gets or sets a value indicating whether include subtypes of the reference type. More...
 
uint NodeClassMask [get, set]
 Specifies the NodeClasses of the TargetNodes. More...
 
uint ResultMask [get, set]
 Specifies the fields in the ReferenceDescription structure that should be returned. More...
 

Detailed Description

The context for a browse operation.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.BrowseContext.BrowseContext ( )

Initializes a new instance of the BrowseContext class.

Property Documentation

BrowseDirection UnifiedAutomation.UaClient.BrowseContext.BrowseDirection
getset

Gets or sets the browse direction.

The default is BrowseDirection.Forward.

bool UnifiedAutomation.UaClient.BrowseContext.IncludeSubtypes
getset

Gets or sets a value indicating whether include subtypes of the reference type.

true if subtypes of the reference type are included; otherwise, false.

The default is true.

uint UnifiedAutomation.UaClient.BrowseContext.MaxReferencesToReturn
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.

uint UnifiedAutomation.UaClient.BrowseContext.NodeClassMask
getset

Specifies the NodeClasses of the TargetNodes.

Only TargetNodes with the selected NodeClasses are returned. The NodeClasses are assigned the following bits:

Bit NodeClass
0 Object
1 Variable
2 Method
3 ObjectType
4 VariableType
5 ReferenceType
6 DataType
7 View

You can use the numeric values of the NodeClass enumeration in code to set the values of this property.

If set to zero, then all NodeClasses are returned.

The default is zero.

If the NodeClass is unknown for a remote Node, the nodeClassMask is ignored.

NodeId UnifiedAutomation.UaClient.BrowseContext.ReferenceTypeId
getset

Specifies the NodeId of the ReferenceType to follow.

Only instances of this ReferenceType are returned. If IncludeSubtypes is set to true, also instances of subtypes of this ReferenceType are returned.

The default is the NodeId of References node. I.e. references of all ReferenceTypes are returned.

uint UnifiedAutomation.UaClient.BrowseContext.ResultMask
getset

Specifies the fields in the ReferenceDescription structure that should be returned.

The fields are assigned the following bits:

Bit Result
0 ReferenceType
1 IsForward
2 NodeClass
3 BrowseName
4 DisplayName
5 TypeDefinition

All bits are set by default.

ViewDescription UnifiedAutomation.UaClient.BrowseContext.View
getset

Description of the View to browse.

An empty ViewDescription value indicates the entire AddressSpace. Use of the empty ViewDescription value causes all References of the nodesToBrowse to be returned. Use of any other View causes only the References of the nodesToBrowse that are defined for that View to be returned.


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