Reference

OpcConditionNodeExtension Members

Type: OpcConditionNodeExtension
Namespace: Opc.UaFx.Server
Assembly: Opc.UaFx.Advanced.dll
Package: Opc.UaFx.Advanced v2.59.0

Methods

ActivateDialog

static

Activates the dialog of the conditionNode specified using the further specified context.

csharp

public static void ActivateDialog(
    this OpcDialogConditionNode conditionNode,
    OpcContext context)

vbnet

Public Shared Sub ActivateDialog(
    conditionNode As OpcDialogConditionNode,
    context As OpcContext)

Parameters

Name	Type	Description
`conditionNode`	OpcDialogConditionNode	The OpcDialogConditionNode its IsActive is to be modified.
`context`	OpcContext	The OpcContext to use to respond.

Exceptions

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The activate operation failed (see exception details for more information).

ChangeComment

static · 2 overloads

Overload	Description
ChangeComment(OpcConditionNode, OpcContext, OpcText)static	Changes the condition 'Comment' state of the `conditionNode` specified using the further specified `context` without raising change events.
ChangeComment(OpcConditionNode, OpcContext, OpcText, string)static	Changes the condition 'Comment' state of the `conditionNode` specified using the further specified `context` without raising change events.

Exceptions (all overloads)

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The state change failed (see exception details for more information).

ChangeComment(OpcConditionNode, OpcContext, OpcText)

static

Changes the condition 'Comment' state of the conditionNode specified using the further specified context without raising change events.

csharp

public static void ChangeComment(
    this OpcConditionNode conditionNode,
    OpcContext context,
    OpcText value)

vbnet

Public Shared Sub ChangeComment(
    conditionNode As OpcConditionNode,
    context As OpcContext,
    value As OpcText)

Parameters

Name	Type	Description
`conditionNode`	OpcConditionNode	The OpcConditionNode its 'Comment' state is to be changed.
`context`	OpcContext	The OpcContext to use to change the state.
`value`	OpcText	The new value to use for the 'Comment' state of the `conditionNode`.

Remarks

This method uses the Identity to determine the 'ClientUserId' to use after changing the 'Comment' state.

ChangeComment(OpcConditionNode, OpcContext, OpcText, string)

static

Changes the condition 'Comment' state of the conditionNode specified using the further specified context without raising change events.

csharp

public static void ChangeComment(
    this OpcConditionNode conditionNode,
    OpcContext context,
    OpcText value,
    string clientUserId)

vbnet

Public Shared Sub ChangeComment(
    conditionNode As OpcConditionNode,
    context As OpcContext,
    value As OpcText,
    clientUserId As String)

Parameters

Name	Type	Description
`conditionNode`	OpcConditionNode	The OpcConditionNode its 'Comment' state is to be changed.
`context`	OpcContext	The OpcContext to use to change the state.
`value`	OpcText	The new value to use for the 'Comment' state of the `conditionNode`.
`clientUserId`	String	The identifier to use for the 'ClientUserId' of the condition node after changing the 'Comment' state.

ChangeIsAcked

static

Changes the condition 'Acked' state of the conditionNode specified using the further specified context without raising change events.

csharp

public static void ChangeIsAcked(
    this OpcAcknowledgeableConditionNode conditionNode,
    OpcContext context,
    bool value)

vbnet

Public Shared Sub ChangeIsAcked(
    conditionNode As OpcAcknowledgeableConditionNode,
    context As OpcContext,
    value As Boolean)

Parameters

Name	Type	Description
`conditionNode`	OpcAcknowledgeableConditionNode	The OpcAcknowledgeableConditionNode its 'Acked' state is to be changed.
`context`	OpcContext	The OpcContext to use to change the state.
`value`	Boolean	The value true to change the condition 'Acked' state to acknowledged; otherwise the value false.

Exceptions

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The state change failed (see exception details for more information).

ChangeIsActive

static

Changes the condition 'Active' state of the conditionNode specified using the further specified context without raising change events.

csharp

public static void ChangeIsActive(
    this OpcAlarmConditionNode conditionNode,
    OpcContext context,
    bool value)

vbnet

Public Shared Sub ChangeIsActive(
    conditionNode As OpcAlarmConditionNode,
    context As OpcContext,
    value As Boolean)

Parameters

Name	Type	Description
`conditionNode`	OpcAlarmConditionNode	The OpcAlarmConditionNode its 'Active' state is to be changed.
`context`	OpcContext	The OpcContext to use to change the state.
`value`	Boolean	The value true to change the condition 'Active' state to active; otherwise the value false.

Exceptions

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The state change failed (see exception details for more information).

ChangeIsConfirmed

static

Changes the condition 'Confirmed' state of the conditionNode specified using the further specified context without raising change events.

csharp

public static void ChangeIsConfirmed(
    this OpcAcknowledgeableConditionNode conditionNode,
    OpcContext context,
    bool value)

vbnet

Public Shared Sub ChangeIsConfirmed(
    conditionNode As OpcAcknowledgeableConditionNode,
    context As OpcContext,
    value As Boolean)

Parameters

Name	Type	Description
`conditionNode`	OpcAcknowledgeableConditionNode	The OpcAcknowledgeableConditionNode its 'Confirmed' state is to be changed.
`context`	OpcContext	The OpcContext to use to change the state.
`value`	Boolean	The value true to change the condition 'Confirmed' state to confirmed; otherwise the value false.

Exceptions

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The state change failed (see exception details for more information).

ChangeIsEnabled

static

Changes the condition 'Enabled' state of the conditionNode specified using the further specified context without raising change events.

csharp

public static void ChangeIsEnabled(
    this OpcConditionNode conditionNode,
    OpcContext context,
    bool value)

vbnet

Public Shared Sub ChangeIsEnabled(
    conditionNode As OpcConditionNode,
    context As OpcContext,
    value As Boolean)

Parameters

Name	Type	Description
`conditionNode`	OpcConditionNode	The OpcConditionNode its 'Enabled' state is to be changed.
`context`	OpcContext	The OpcContext to use to change the state.
`value`	Boolean	The value true to change the condition 'Enabled' state to enabled; otherwise the value false.

Exceptions

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The state change failed (see exception details for more information).

ChangeIsSuppressed

static

Changes the condition 'Suppressed' state of the conditionNode specified using the further specified context without raising change events.

csharp

public static void ChangeIsSuppressed(
    this OpcAlarmConditionNode conditionNode,
    OpcContext context,
    bool value)

vbnet

Public Shared Sub ChangeIsSuppressed(
    conditionNode As OpcAlarmConditionNode,
    context As OpcContext,
    value As Boolean)

Parameters

Name	Type	Description
`conditionNode`	OpcAlarmConditionNode	The OpcAlarmConditionNode its 'Suppressed' state is to be changed.
`context`	OpcContext	The OpcContext to use to change the state.
`value`	Boolean	The value true to change the condition 'Suppressed' state to suppressed; otherwise the value false.

Exceptions

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The state change failed (see exception details for more information).

ChangeLimitState

static · 2 overloads

Overload	Description
ChangeLimitState(OpcExclusiveLimitAlarmNode, OpcContext, OpcLimitAlarmStates)static	Changes the condition current limit alarm state of the `conditionNode` specified using the further specified `context`.
ChangeLimitState(OpcNonExclusiveLimitAlarmNode, OpcContext, OpcLimitAlarmStates)static	Changes the condition current limit alarm state of the `conditionNode` specified using the further specified `context`.

Exceptions (all overloads)

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The limit alarm state change failed (see exception details for more information).

ChangeLimitState(OpcExclusiveLimitAlarmNode, OpcContext, OpcLimitAlarmStates)

static

Changes the condition current limit alarm state of the conditionNode specified using the further specified context.

csharp

public static void ChangeLimitState(
    this OpcExclusiveLimitAlarmNode conditionNode,
    OpcContext context,
    OpcLimitAlarmStates value)

vbnet

Public Shared Sub ChangeLimitState(
    conditionNode As OpcExclusiveLimitAlarmNode,
    context As OpcContext,
    value As OpcLimitAlarmStates)

Parameters

Name	Type	Description
`conditionNode`	OpcExclusiveLimitAlarmNode	The OpcExclusiveLimitAlarmNode its current limit alarm state is to be changed.
`context`	OpcContext	The OpcContext to use to change the current limit alarm state.
`value`	OpcLimitAlarmStates	A value of the OpcLimitAlarmStates enumeration to apply as the new limit alarm state.

ChangeLimitState(OpcNonExclusiveLimitAlarmNode, OpcContext, OpcLimitAlarmStates)

static

Changes the condition current limit alarm state of the conditionNode specified using the further specified context.

csharp

public static void ChangeLimitState(
    this OpcNonExclusiveLimitAlarmNode conditionNode,
    OpcContext context,
    OpcLimitAlarmStates value)

vbnet

Public Shared Sub ChangeLimitState(
    conditionNode As OpcNonExclusiveLimitAlarmNode,
    context As OpcContext,
    value As OpcLimitAlarmStates)

Parameters

Name	Type	Description
`conditionNode`	OpcNonExclusiveLimitAlarmNode	The OpcNonExclusiveLimitAlarmNode its current limit alarm state is to be changed.
`context`	OpcContext	The OpcContext to use to change the current limit alarm state.
`value`	OpcLimitAlarmStates	A value of the OpcLimitAlarmStates enumeration to apply as the new limit alarm state.

ChangeSeverity

static

Changes the condition 'Severity' of the conditionNode specified using the further specified context without raising change events.

csharp

public static void ChangeSeverity(
    this OpcConditionNode conditionNode,
    OpcContext context,
    OpcEventSeverity value)

vbnet

Public Shared Sub ChangeSeverity(
    conditionNode As OpcConditionNode,
    context As OpcContext,
    value As OpcEventSeverity)

Parameters

Name	Type	Description
`conditionNode`	OpcConditionNode	The OpcConditionNode its 'Severity' is to be changed.
`context`	OpcContext	The OpcContext to use to change the severity.
`value`	OpcEventSeverity	The OpcEventSeverity to change to.

Exceptions

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The severity change failed (see exception details for more information).

ChangeShelving

static · 3 overloads

Overload	Description
ChangeShelving(OpcAlarmConditionNode, OpcContext, bool)static	Changes the condition 'Shelving' of the `conditionNode` specified using the further specified `context`.
ChangeShelving(OpcAlarmConditionNode, OpcContext, bool, bool)static	Changes the condition 'Shelving' of the `conditionNode` specified using the further specified `context`.
ChangeShelving(OpcAlarmConditionNode, OpcContext, bool, bool, TimeSpan)static	Changes the condition 'Shelving' of the `conditionNode` specified using the further specified `context`.

Exceptions (all overloads)

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The shelving change failed (see exception details for more information).

ChangeShelving(OpcAlarmConditionNode, OpcContext, bool)

static

Changes the condition 'Shelving' of the conditionNode specified using the further specified context.

csharp

public static void ChangeShelving(
    this OpcAlarmConditionNode conditionNode,
    OpcContext context,
    bool shelved)

vbnet

Public Shared Sub ChangeShelving(
    conditionNode As OpcAlarmConditionNode,
    context As OpcContext,
    shelved As Boolean)

Parameters

Name	Type	Description
`conditionNode`	OpcAlarmConditionNode	The OpcAlarmConditionNode its 'Shelving' is to be changed.
`context`	OpcContext	The OpcContext to use to change the shelving.
`shelved`	Boolean	The value true to shelve the condition; otherwise the value false.

ChangeShelving(OpcAlarmConditionNode, OpcContext, bool, bool)

static

Changes the condition 'Shelving' of the conditionNode specified using the further specified context.

csharp

public static void ChangeShelving(
    this OpcAlarmConditionNode conditionNode,
    OpcContext context,
    bool shelved,
    bool oneShot)

vbnet

Public Shared Sub ChangeShelving(
    conditionNode As OpcAlarmConditionNode,
    context As OpcContext,
    shelved As Boolean,
    oneShot As Boolean)

Parameters

Name	Type	Description
`conditionNode`	OpcAlarmConditionNode	The OpcAlarmConditionNode its 'Shelving' is to be changed.
`context`	OpcContext	The OpcContext to use to change the shelving.
`shelved`	Boolean	The value true to shelve the condition; otherwise the value false.
`oneShot`	Boolean	The value true if the shelving only applies once; otherwise the value false.

ChangeShelving(OpcAlarmConditionNode, OpcContext, bool, bool, TimeSpan)

static

Changes the condition 'Shelving' of the conditionNode specified using the further specified context.

csharp

public static void ChangeShelving(
    this OpcAlarmConditionNode conditionNode,
    OpcContext context,
    bool shelved,
    bool oneShot,
    TimeSpan shelvingTime)

vbnet

Public Shared Sub ChangeShelving(
    conditionNode As OpcAlarmConditionNode,
    context As OpcContext,
    shelved As Boolean,
    oneShot As Boolean,
    shelvingTime As TimeSpan)

Parameters

Name	Type	Description
`conditionNode`	OpcAlarmConditionNode	The OpcAlarmConditionNode its 'Shelving' is to be changed.
`context`	OpcContext	The OpcContext to use to change the shelving.
`shelved`	Boolean	The value true to shelve the condition; otherwise the value false.
`oneShot`	Boolean	The value true if the shelving only applies once; otherwise the value false.
`shelvingTime`	TimeSpan	The time as long the shelving applies.

RespondDialog

static

Changes the dialog response of the conditionNode specified using the further specified context.

csharp

public static void RespondDialog(
    this OpcDialogConditionNode conditionNode,
    OpcContext context,
    int response)

vbnet

Public Shared Sub RespondDialog(
    conditionNode As OpcDialogConditionNode,
    context As OpcContext,
    response As Integer)

Parameters

Name	Type	Description
`conditionNode`	OpcDialogConditionNode	The OpcDialogConditionNode its IsActive and LastResponse is to be modified.
`context`	OpcContext	The OpcContext to use to respond.
`response`	Int32	The index of the item in the ResponseOptions.

Exceptions

Exception	Condition
ArgumentNullException	The `conditionNode` or `context` is a null reference (Nothing in Visual Basic).
InvalidOperationException	The node has not yet been fully initialized. Call this method after the node has been initialized through CreateNodes.
OpcException	The respond operation failed (see exception details for more information).

OpcConditionNodeExtension Members

OpcConditionNodeExtension Members ​

Methods ​

ActivateDialog ​

ChangeComment ​

ChangeComment(OpcConditionNode, OpcContext, OpcText) ​

ChangeComment(OpcConditionNode, OpcContext, OpcText, string) ​

ChangeIsAcked ​

ChangeIsActive ​

ChangeIsConfirmed ​

ChangeIsEnabled ​

ChangeIsSuppressed ​

ChangeLimitState ​

ChangeLimitState(OpcExclusiveLimitAlarmNode, OpcContext, OpcLimitAlarmStates) ​

ChangeLimitState(OpcNonExclusiveLimitAlarmNode, OpcContext, OpcLimitAlarmStates) ​

ChangeSeverity ​

ChangeShelving ​

ChangeShelving(OpcAlarmConditionNode, OpcContext, bool) ​

ChangeShelving(OpcAlarmConditionNode, OpcContext, bool, bool) ​

ChangeShelving(OpcAlarmConditionNode, OpcContext, bool, bool, TimeSpan) ​

RespondDialog ​

OpcConditionNodeExtension Members

Methods

ActivateDialog

ChangeComment

ChangeComment(OpcConditionNode, OpcContext, OpcText)

ChangeComment(OpcConditionNode, OpcContext, OpcText, string)

ChangeIsAcked

ChangeIsActive

ChangeIsConfirmed

ChangeIsEnabled

ChangeIsSuppressed

ChangeLimitState

ChangeLimitState(OpcExclusiveLimitAlarmNode, OpcContext, OpcLimitAlarmStates)

ChangeLimitState(OpcNonExclusiveLimitAlarmNode, OpcContext, OpcLimitAlarmStates)

ChangeSeverity

ChangeShelving

ChangeShelving(OpcAlarmConditionNode, OpcContext, bool)

ChangeShelving(OpcAlarmConditionNode, OpcContext, bool, bool)

ChangeShelving(OpcAlarmConditionNode, OpcContext, bool, bool, TimeSpan)

RespondDialog