Reference

OpcPathProbing Members

Type

OpcPathProbing

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcPathProbing

protected

Initializes a new instance of the OpcPathProbing class.

protected OpcPathProbing()

Protected Sub New()

Methods

Evaluate

Processes the evaluation of the string-based path value associated with this OpcPathProbing and offers the determined and fulfilled path information accordingly.

public string Evaluate()

Public Function Evaluate() As String

Returns

String

The full qualified string-based path which fulfills the needs of existence, accessibility and other circumstances or a null reference (Nothing in Visual Basic) if the path information could not fulfill at least one of the requirements associated with this OpcPathProbing. For more information about the failure of the evaluation handle the Failed event of this instance accordingly.

EvaluateCore

protected · abstract

When implemented in a derived class, processes the implementation specific evaluation of the string-based path value associated with this OpcPathProbing specialization and offers the determined and fulfilled path information accordingly.

protected abstract string EvaluateCore()

Protected MustOverride Function EvaluateCore() As String

Returns

String

The full qualified string-based path which fulfills the needs of this probing or a null reference (Nothing in Visual Basic) if the path information could not fulfill at least one of the requirements of this probing.

OnFailed

protected · virtual

Raises the Failed event of the OpcPathProbing.

protected virtual void OnFailed(OpcPathProbingFailedEventArgs e)

Protected Overridable Sub OnFailed(e As OpcPathProbingFailedEventArgs)

Parameters

Name	Type	Description
e	OpcPathProbingFailedEventArgs	The event data offering the reason of the failed evaluation.

ReportFailed

protected · 3 overloads

Overload	Description
ReportFailed(Exception)protected	Reports the failure of the evaluation using the exception which led to the nonsuccess.
ReportFailed(Exception, string, params object[])protected	Reports the failure of the evaluation using the exception which led to the nonsuccess.
ReportFailed(string, params object[])protected	Reports the failure of the evaluation using the message and arguments information to describe the evaluation task which failed.

ReportFailed(Exception)

protected

Reports the failure of the evaluation using the exception which led to the nonsuccess.

protected void ReportFailed(Exception exception)

Protected Sub ReportFailed(exception As Exception)

Parameters

Name	Type	Description
exception	Exception	The Exception instance which led to the nonsuccess reported or a null reference (Nothing in Visual Basic) if there is no exceptional information available.

ReportFailed(Exception, string, params object[])

protected

Reports the failure of the evaluation using the exception which led to the nonsuccess. The further defined message and arguments offer additional information about the source of the exception or which evaluation task has failed.

protected void ReportFailed(
    Exception exception,
    string message,
    params object[] arguments)

Protected Sub ReportFailed(
    exception As Exception,
    message As String,
    ParamArray arguments As Object())

Parameters

Name	Type	Description
exception	Exception	The Exception instance which led to the nonsuccess reported or a null reference (Nothing in Visual Basic) if there is no exceptional information available.
message	String	The additional description about the failure or a null reference (Nothing in Visual Basic) if there is no more information available. In case there the message is a null reference (Nothing in Visual Basic) a default message is used instead.
arguments	params Object[]	The arguments to format into the message specified. If message is a null reference (Nothing in Visual Basic) the array of object values is ignored.

ReportFailed(string, params object[])

protected

Reports the failure of the evaluation using the message and arguments information to describe the evaluation task which failed.

protected void ReportFailed(string message, params object[] arguments)

Protected Sub ReportFailed(message As String, ParamArray arguments As Object())

Parameters

Name	Type	Description
message	String	The description about the failure or a null reference (Nothing in Visual Basic) if there is no information available. In case there the message is a null reference (Nothing in Visual Basic) a default message is used instead.
arguments	params Object[]	The arguments to format into the message specified. If message is a null reference (Nothing in Visual Basic) the array of object values is ignored.

Events

Failed

Occurs when a call to Evaluate failed upon a specific reason. This can be either an exception during the evaluation or the path information does not fulfill one of the circumstances the evaluation assures.

public event OpcPathProbingFailedEventHandler Failed

Public Event Failed As OpcPathProbingFailedEventHandler

Event type

OpcPathProbingFailedEventHandler