C++ Based OPC UA Client/Server SDK  1.5.5.355
UaClientSdk::BrowseContext Class Reference

The BrowseContext class contains the settings for a browse request. More...

#include <uaclientsdk.h>

Public Member Functions

 BrowseContext ()
 Creates a BrowseContext object with settings to browse hierarchical references in forward direction and other default settings described for the parameters.
 
 ~BrowseContext ()
 Destroys the browse context object. More...
 

Public Attributes

OpcUa_ViewDescription view
 Optional view parameter allows browsing in a view context. More...
 
OpcUa_UInt32 maxReferencesToReturn
 Parameter to limit the number of results per node. More...
 
OpcUa_BrowseDirection browseDirection
 The direction of the browse with option forward, inverse or both. More...
 
UaNodeId referenceTypeId
 The type of reference to follow. More...
 
OpcUa_Boolean includeSubtype
 Indicates if the referenceTypeId to follow should include subtypes. More...
 
OpcUa_UInt32 nodeClassMask
 NodeClass filter mask. More...
 
OpcUa_UInt32 resultMask
 Result mask to define results to be returned with the browse response. More...
 

Detailed Description

The BrowseContext class contains the settings for a browse request.

Constructor & Destructor Documentation

UaClientSdk::BrowseContext::~BrowseContext ( )
inline

Destroys the browse context object.

Member Data Documentation

OpcUa_BrowseDirection UaClientSdk::BrowseContext::browseDirection

The direction of the browse with option forward, inverse or both.

The default value is forward. Possible options are

  • OpcUa_BrowseDirection_Forward
  • OpcUa_BrowseDirection_Inverse
  • OpcUa_BrowseDirection_Both
OpcUa_Boolean UaClientSdk::BrowseContext::includeSubtype

Indicates if the referenceTypeId to follow should include subtypes.

The default value is true.

OpcUa_UInt32 UaClientSdk::BrowseContext::maxReferencesToReturn

Parameter to limit the number of results per node.

A server can further limit the number it returns. If the the number of available results exceeds the client or server limit, a continuation point is returned in the browse response. The default value is 0.

OpcUa_UInt32 UaClientSdk::BrowseContext::nodeClassMask

NodeClass filter mask.

The default value is 0 to return all NodeClasses.

Possible masks to set are

  • OpcUa_NodeClass_Object = 1,
  • OpcUa_NodeClass_Variable = 2,
  • OpcUa_NodeClass_Method = 4,
  • OpcUa_NodeClass_ObjectType = 8,
  • OpcUa_NodeClass_VariableType = 16,
  • OpcUa_NodeClass_ReferenceType = 32,
  • OpcUa_NodeClass_DataType = 64,
  • OpcUa_NodeClass_View = 128
UaNodeId UaClientSdk::BrowseContext::referenceTypeId

The type of reference to follow.

The NodeId of the reference type to follow in the browse request. This parameter is used in combination with includeSubtype. If abstract base reference types are specified, the parameter ref includeSubtype must be set to true. The default value is OpcUaId_HierarchicalReferences.

OpcUa_UInt32 UaClientSdk::BrowseContext::resultMask

Result mask to define results to be returned with the browse response.

The default value is OpcUa_BrowseResultMask_All to return all results. The NodeIds of the target nodes are always returned. It is recommended to request only the information that is used by the client application. Possible result masks to set are

  • OpcUa_BrowseResultMask_None = 0,
  • OpcUa_BrowseResultMask_ReferenceTypeId = 1,
  • OpcUa_BrowseResultMask_IsForward = 2,
  • OpcUa_BrowseResultMask_NodeClass = 4,
  • OpcUa_BrowseResultMask_BrowseName = 8,
  • OpcUa_BrowseResultMask_DisplayName = 16,
  • OpcUa_BrowseResultMask_TypeDefinition = 32,
  • OpcUa_BrowseResultMask_All = 63,
  • OpcUa_BrowseResultMask_ReferenceTypeInfo = 3,
  • OpcUa_BrowseResultMask_TargetInfo = 60
OpcUa_ViewDescription UaClientSdk::BrowseContext::view

Optional view parameter allows browsing in a view context.

The view context includes a view NodeId and an optional view version or view timestamp. The default setting is a null ViewDescription.


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