.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaServer.ContinuationPoint Class Reference

The continuation point for a browse operation. More...

Inherits IDisposable.

Public Member Functions

 ContinuationPoint ()
 Initializes the object with default values. More...
 
void Dispose ()
 Frees any unmanaged resources. More...
 
bool IsReferenceSelected (RequestContext context, NodeId referenceTypeId, bool isInverse)
 Determines whether [is reference selected] [the specified candidate reference type id]. More...
 
bool IsNodeSelected (QualifiedName browseName, NodeClass nodeClass)
 Checks if the current node meets the filter criteria for the browse operation. More...
 
CheckMaxReferences< T > (IList< ReferenceDescription > results)
 Checks the max references per node and returns a new continuation point if reached. More...
 

Protected Member Functions

virtual void Dispose (bool disposing)
 An overrideable version of the Dispose. More...
 

Properties

Guid Id [get, set]
 A unique identifier for the continuation point. More...
 
INodeManager NodeManager [get, set]
 Gets or sets the node manager. More...
 
BrowseHandle NodeToBrowse [get, set]
 Gets or sets the browse handle. More...
 
ViewHandle ViewToBrowse [get, set]
 Gets or sets the view handle. More...
 
BrowseDescription Settings [get, set]
 Gets or sets the settings. More...
 
uint MaxReferencesPerNode [get, set]
 Gets or sets the max references per node. More...
 
uint StartingReferenceCount [get, set]
 Gets or sets the starting reference count. More...
 
QualifiedName TargetName [get, set]
 Gets or sets the target name (specified when translating a browse path). More...
 
int Stage [get, set]
 Gets or sets the stage (used by the entity that created the continuation point). More...
 
object UserData [get, set]
 Node manager specific data that is necessary to continue the browse. More...
 
List< ReferenceNodeUnprocessedReferences [get, set]
 Gets or sets any unprocessed references. More...
 

Detailed Description

The continuation point for a browse operation.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.ContinuationPoint.ContinuationPoint ( )

Initializes the object with default values.

Member Function Documentation

T UnifiedAutomation.UaServer.ContinuationPoint.CheckMaxReferences< T > ( IList< ReferenceDescription results)

Checks the max references per node and returns a new continuation point if reached.

Template Parameters
TThe type of ContinuationPoint to create.
Returns
The new continuation point if browsing must stop. null otherwise.
Type Constraints
T :ContinuationPoint 
T :new() 
void UnifiedAutomation.UaServer.ContinuationPoint.Dispose ( )

Frees any unmanaged resources.

virtual void UnifiedAutomation.UaServer.ContinuationPoint.Dispose ( bool  disposing)
protectedvirtual

An overrideable version of the Dispose.

bool UnifiedAutomation.UaServer.ContinuationPoint.IsNodeSelected ( QualifiedName  browseName,
NodeClass  nodeClass 
)

Checks if the current node meets the filter criteria for the browse operation.

Parameters
browseNameThe browse name of the node.
nodeClassThe node class of the node.
Returns
True if the reference should be included in the result set.
bool UnifiedAutomation.UaServer.ContinuationPoint.IsReferenceSelected ( RequestContext  context,
NodeId  referenceTypeId,
bool  isInverse 
)

Determines whether [is reference selected] [the specified candidate reference type id].

Parameters
contextThe request context.
referenceTypeIdThe reference type id.
isInverseSet to true if the reference is an inverse reference.
Returns
true if [is reference selected] [the specified candidate reference type id]; otherwise, false.

Property Documentation

Guid UnifiedAutomation.UaServer.ContinuationPoint.Id
getset

A unique identifier for the continuation point.

uint UnifiedAutomation.UaServer.ContinuationPoint.MaxReferencesPerNode
getset

Gets or sets the max references per node.

The max references per node.

INodeManager UnifiedAutomation.UaServer.ContinuationPoint.NodeManager
getset

Gets or sets the node manager.

The node manager.

BrowseHandle UnifiedAutomation.UaServer.ContinuationPoint.NodeToBrowse
getset

Gets or sets the browse handle.

The browse handle.

BrowseDescription UnifiedAutomation.UaServer.ContinuationPoint.Settings
getset

Gets or sets the settings.

The settings.

int UnifiedAutomation.UaServer.ContinuationPoint.Stage
getset

Gets or sets the stage (used by the entity that created the continuation point).

The stage.

uint UnifiedAutomation.UaServer.ContinuationPoint.StartingReferenceCount
getset

Gets or sets the starting reference count.

The starting reference count.

QualifiedName UnifiedAutomation.UaServer.ContinuationPoint.TargetName
getset

Gets or sets the target name (specified when translating a browse path).

The target name.

List<ReferenceNode> UnifiedAutomation.UaServer.ContinuationPoint.UnprocessedReferences
getset

Gets or sets any unprocessed references.

The unprocessed references.

object UnifiedAutomation.UaServer.ContinuationPoint.UserData
getset

Node manager specific data that is necessary to continue the browse.

A node manager needs to hold onto unmanaged resources to continue the browse. If this is the case then the object stored here must implement the Idispose interface. This will ensure the unmanaged resources are freed if the continuation point expires.

ViewHandle UnifiedAutomation.UaServer.ContinuationPoint.ViewToBrowse
getset

Gets or sets the view handle.

The view handle.


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