Skip to content

Reference

OpcConditionExtension Members

Provides static (Shared in Visual Basic) extension methods to manage OpcCondition objects.

Reference

OpcConditionExtension Members ​

Type
OpcConditionExtension
Namespace
Opc.UaFx.Client
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Also in
Opc.UaFx.Client

Methods ​

AddComment ​

static · 2 overloads

OverloadDescription
AddComment(OpcCondition, OpcClient, OpcText)staticApplies a comment to the state reported by an event notification which can be identified by the EventId of the condition specified using the further specified client.
AddComment(OpcCondition, OpcClient, byte[], OpcText)staticApplies a comment to the state reported by an event notification which can be identified by the eventId on the condition specified using the further specified client.

Exceptions (all overloads)

ExceptionCondition
OpcExceptionThe call of the method node failed (see exception details for more information).

AddComment(OpcCondition, OpcClient, OpcText) ​

static

Applies a comment to the state reported by an event notification which can be identified by the EventId of the condition specified using the further specified client.

csharp
public static void AddComment(
    this OpcCondition condition,
    OpcClient client,
    OpcText comment)
vbnet
Public Shared Sub AddComment(
    condition As OpcCondition,
    client As OpcClient,
    comment As OpcText)

Parameters

NameTypeDescription
conditionOpcConditionThe OpcCondition its 'AddComment' method node is to be called.
clientOpcClientThe OpcClient to use to call the method.
commentOpcTextThe text to apply on the condition state.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe condition or client is a null reference (Nothing in Visual Basic).

AddComment(OpcCondition, OpcClient, byte[], OpcText) ​

static

Applies a comment to the state reported by an event notification which can be identified by the eventId on the condition specified using the further specified client.

csharp
public static void AddComment(
    this OpcCondition condition,
    OpcClient client,
    byte[] eventId,
    OpcText comment)
vbnet
Public Shared Sub AddComment(
    condition As OpcCondition,
    client As OpcClient,
    eventId As Byte(),
    comment As OpcText)

Parameters

NameTypeDescription
conditionOpcConditionThe OpcCondition its 'AddComment' method node is to be called.
clientOpcClientThe OpcClient to use to call the method.
eventIdByte[]The identifier which identifies the particular event notification its reported state for the condition is to be commented.
commentOpcTextThe text to apply on the condition state.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe condition, client or eventId is a null reference (Nothing in Visual Basic).

Disable ​

static

Changes the condition state to 'Disabled' of the condition specified using the further specified client.

csharp
public static void Disable(this OpcCondition condition, OpcClient client)
vbnet
Public Shared Sub Disable(condition As OpcCondition, client As OpcClient)

Parameters

NameTypeDescription
conditionOpcConditionThe OpcCondition its 'Disable' method node is to be called.
clientOpcClientThe OpcClient to use to call the method.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe condition or client is a null reference (Nothing in Visual Basic).
OpcExceptionThe call of the method node failed (see exception details for more information).

Enable ​

static

Changes the condition state to 'Enabled' of the condition specified using the further specified client.

csharp
public static void Enable(this OpcCondition condition, OpcClient client)
vbnet
Public Shared Sub Enable(condition As OpcCondition, client As OpcClient)

Parameters

NameTypeDescription
conditionOpcConditionThe OpcCondition its 'Enable' method node is to be called.
clientOpcClientThe OpcClient to use to call the method.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe condition or client is a null reference (Nothing in Visual Basic).
OpcExceptionThe call of the method node failed (see exception details for more information).