C++ Based OPC UA Client/Server/PubSub SDK
1.7.3.505
|
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... | |
The BrowseContext class contains the settings for a browse request.
|
inline |
Destroys the browse context object.
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_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
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_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.