BrowseContext Class Reference

Class for handling of continuation point in browse service. This Interface makes all possible Events available. It is not possible to create plane copies of this Class. More...

#include <continuationpoint.h>

Collaboration diagram for BrowseContext:

[legend]

List of all members.

Public Member Functions
	BrowseContext (OpcUa_ViewDescription *pView, OpcUa_NodeId *pNodeToBrowse, OpcUa_UInt32 uMaxResultsToReturn, OpcUa_BrowseDirection BrowseDirection, OpcUa_NodeId *pReferenceTypeId, OpcUa_Boolean bIncludeSubtype, OpcUa_UInt32 uNodeClassMask, OpcUa_UInt32 uResultMask)
virtual	~BrowseContext ()
OpcUa_ViewDescription *	pView ()
OpcUa_NodeId *	pNodeToBrowse ()
OpcUa_UInt32	uMaxResultsToReturn ()
OpcUa_BrowseDirection	BrowseDirection ()
OpcUa_NodeId *	pReferenceTypeId ()
OpcUa_Boolean	bIncludeSubtype ()
OpcUa_UInt32	uNodeClassMask ()
OpcUa_UInt32	uResultMask ()
void	setResultMask (OpcUa_UInt32 uResultMask)
OpcUa_Boolean	isFirstBrowse ()
void	setUserData (ContinuationPointUserDataBase *pContinuationPointUserDataBase)
ContinuationPointUserDataBase *	detachUserData ()
OpcUa_Byte	CPCounter ()
void	setCPCounter (OpcUa_Byte CPCounter)
OpcUa_Boolean	isLastBrowse ()

---

Detailed Description

Class for handling of continuation point in browse service. This Interface makes all possible Events available. It is not possible to create plane copies of this Class.

BrowseContext

---

Constructor & Destructor Documentation

BrowseContext::BrowseContext	(	OpcUa_ViewDescription *	pView,
		OpcUa_NodeId *	pNodeToBrowse,
		OpcUa_UInt32	uMaxResultsToReturn,
		OpcUa_BrowseDirection	BrowseDirection,
		OpcUa_NodeId *	pReferenceTypeId,
		OpcUa_Boolean	bIncludeSubtype,
		OpcUa_UInt32	uNodeClassMask,
		OpcUa_UInt32	uResultMask
	)

construction

construction

Parameters:

	pView	the description of the Node.
	pNodeToBrowse	the actual Node to browse.
	uMaxResultsToReturn	the maximum results of a browse to return.
	BrowseDirection	Directs the Browsedirection of the Server (Inverse / Forward).
	pReferenceTypeId	a pointer to the TypeId of the reference.
	bIncludeSubtype	true if included false if not.
	uNodeClassMask	the node class mask.
	uResultMask	the result mask.

BrowseContext::~BrowseContext

(

)

[virtual]

destruction

---

Member Function Documentation

OpcUa_ViewDescription* BrowseContext::pView

(

)

[inline]

View the Description of the Nodes.

Returns:

The Description of the browsed Node.

OpcUa_NodeId* BrowseContext::pNodeToBrowse

(

)

[inline]

A Method to browse the Nodes of the Server.

Returns:

The Description of the currently browsed Nodes.

OpcUa_UInt32 BrowseContext::uMaxResultsToReturn

(

)

[inline]

A Method which returns the maximum result of the Nodes.

Returns:

the maximum result of Nodes.

OpcUa_BrowseDirection BrowseContext::BrowseDirection

(

)

[inline]

Directs the Browsedirection of the Server (Inverse / Forward).

Returns:

the Browsedirection.

OpcUa_NodeId* BrowseContext::pReferenceTypeId

(

)

[inline]

Get the Referencetypeid of a Node.

Returns:

the Referencetypeid of the current Node.

OpcUa_Boolean BrowseContext::bIncludeSubtype

(

)

[inline]

Checks if there are Subtypes of a Node.

Returns:

a bool value wether the Node has a Subtype or not.

OpcUa_UInt32 BrowseContext::uNodeClassMask

(

)

[inline]

Checks if there are Variables in the Nodeclassmask.

Returns:

a Value with an information if there is a Variable or an Object.

OpcUa_UInt32 BrowseContext::uResultMask

(

)

[inline]

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

Returns:

result mask.

void BrowseContext::setResultMask

(

OpcUa_UInt32

uResultMask

)

[inline]

Allows setting of the result mask.

OpcUa_Boolean BrowseContext::isFirstBrowse

(

)

[inline]

Can be used to check if it is the first browse with this context In the case of OpcUa_True, it is the first browse call with this browse context. In the case of OpcUa_False, it is a browse next call with a continuation point.

Returns:

a bool value to check wether this was the first browse with the current context.

void BrowseContext::setUserData

(

ContinuationPointUserDataBase *

pContinuationPointUserDataBase

)

Set user data if not all nodes can be returned to prepare Continuation Point for next browse

Parameters:

pContinuationPointUserDataBase

used to check if not all nodes can be returned to prepare Continuation Point for next browse.

Set user data if not all nodes can be returned to prepare Continuation Point for next browse.

Parameters:

pContinuationPointUserDataBase

used to check if not all nodes can be returned to prepare Continuation Point for next browse.

ContinuationPointUserDataBase * BrowseContext::detachUserData

(

)

Detach user data to continue browse

Returns:

the detached user data.

Detach user data to continue browse.

Returns:

a pointer to the continuation point user data base.

OpcUa_Byte BrowseContext::CPCounter

(

)

[inline]

This member is used for management of the continuation point in the SDK

Returns:

the counted continuation point in the SDK.

void BrowseContext::setCPCounter

(

OpcUa_Byte

CPCounter

)

[inline]

This member is used for management of the continuation point in the SDK

Parameters:

CPCounter

This Variable is set to the Value of the Membervariable.

OpcUa_Boolean BrowseContext::isLastBrowse

(

)

[inline]

Flag that tells the SDK if it was the last browse call and all references are returned. The flag is set by the methods setUserData (OpcUa_False) since this indicates that a continuation point is necessary or by detachUserData (OpcUa_True) since the continuation point is handled in a next browse. The default value is OpcUa_True.

Returns:

a value used to recognize wether this was the last browsecall or not.

---

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

• src/uaserver/uaservercpp/coremodule/continuationpoint.h
• src/uaserver/uaservercpp/coremodule/continuationpoint.cpp