C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

Callback interface for user specific browse result manipulation. More...

#include <nodemanageruanode.h>

Inherits BrowseCallback.

Public Member Functions

virtual OpcUa_Boolean browseNode (Session *pSession, const BrowseContext &browseContext, UaNode *pNodeToBrowse) const =0
 This method tells the NodeManagerUaNode whether the requested node pNodeToBrowse should return any browse result. More...
 
virtual OpcUa_Boolean returnBrowseResultNode (Session *pSession, const BrowseContext &browseContext, UaNode *pNodeToBrowse, const UaNodeId &referenceTypeId, UaNode *pResultNode) const =0
 This method tells the NodeManagerUaNode whether the result node should be returned to the client. More...
 
virtual void modifyBrowseResultNode (Session *pSession, UaNode *pResultNode, OpcUa_ReferenceDescription &browseResult) const
 This optional method allows the callback to modify the node results e.g. More...
 

Detailed Description

Callback interface for user specific browse result manipulation.

This interface needs to be registered with the NodeManagerUaNode using the method NodeManagerUaNode::registerBrowseUaNodeCallback. The methods of this interface allow the product specific implementation to manipulate the results of browse calls to the NodeManagerUaNode for example to limit browse access to nodes based on the user logged on for the session.

Member Function Documentation

virtual OpcUa_Boolean BrowseUaNodeCallback::browseNode ( Session pSession,
const BrowseContext browseContext,
UaNode pNodeToBrowse 
) const
pure virtual

This method tells the NodeManagerUaNode whether the requested node pNodeToBrowse should return any browse result.

Returns
OpcUa_True if the user is allowed to browse the node and OpcUa_False if not.
Parameters
[in]pSessionSession context for the browse call. A user defined derived class must contain the user context.
[in]browseContextBrowse context for the browse call.
[in]pNodeToBrowseUaNode interface of the node requested to be browsed.
void BrowseUaNodeCallback::modifyBrowseResultNode ( Session pSession,
UaNode pResultNode,
OpcUa_ReferenceDescription browseResult 
) const
virtual

This optional method allows the callback to modify the node results e.g.

the DisplayName language.

Parameters
[in]pSessionSession context for the browse call. A user defined derived class must contain the user context.
[in]pResultNodeUaNode interface of the node to be returned by the browse call.
[in,out]browseResultBrowse result for the node. The result can be modified by the method.
virtual OpcUa_Boolean BrowseUaNodeCallback::returnBrowseResultNode ( Session pSession,
const BrowseContext browseContext,
UaNode pNodeToBrowse,
const UaNodeId referenceTypeId,
UaNode pResultNode 
) const
pure virtual

This method tells the NodeManagerUaNode whether the result node should be returned to the client.

Returns
OpcUa_True if the node should be returned and OpcUa_False if not.
Parameters
[in]pSessionSession context for the browse call. A user defined derived class must contain the user context.
[in]browseContextBrowse context for the browse call.
[in]pNodeToBrowseUaNode interface of the browsed node.
[in]referenceTypeIdThe reference type NodeId from the browsed node to the result node.
[in]pResultNodeUaNode interface of the node requested to be returned by the browse call.

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