GetConditionState Method (EasyAEClient)

Returns the current state information for the condition instance corresponding to the source and condition name, passing in a server descriptor. Also allows to retrieve specified event attributes.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function GetConditionState( _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal sourceDescriptor As AENodeDescriptor, _
   ByVal conditionName As String, _
   ByVal attributes() As Long _
) As AEConditionState

'Usage
 
Dim instance As EasyAEClient
Dim serverDescriptor As ServerDescriptor
Dim sourceDescriptor As AENodeDescriptor
Dim conditionName As String
Dim attributes() As Long
Dim value As AEConditionState
 
value = instance.GetConditionState(serverDescriptor, sourceDescriptor, conditionName, attributes)

public AEConditionState GetConditionState( 
   ServerDescriptor serverDescriptor,
   AENodeDescriptor sourceDescriptor,
   string conditionName,
   long[] attributes
)

public:
AEConditionState^ GetConditionState( 
   ServerDescriptor^ serverDescriptor,
   AENodeDescriptor^ sourceDescriptor,
   String^ conditionName,
   array<int64>^ attributes
)

Parameters

serverDescriptor: The OPC server involved in the operation.
sourceDescriptor: Contains fully qualified source name, as returned by browsing. The state of the condition instance associated with this source is returned.
conditionName: A condition name, as returned by querying. The state of this condition is returned.
attributes: Specifies the event attributes to be returned.

Return Value

If successful, the function returns a AEConditionState object. The object contains information about the state of the condition.

Exceptions

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument.
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method.
OpcLabs.EasyOpc.OperationModel.OpcException	The OPC "Classic" (or OPC XML-DA) operation has failed.

Remarks

The server can be local or can be remotely accessed via DCOM. Optionally, an access path can be specified or a specific data type can be requested.

Some servers may not maintain sufficient condition state information to fully implement this method.

Example

CSharp
VB.NET

// This example shows how to obtain current state information for the condition instance corresponding to a Source and 
// certain ConditionName.

using System;
using OpcLabs.EasyOpc.AlarmsAndEvents;
using OpcLabs.EasyOpc.OperationModel;

namespace DocExamples.AlarmsAndEvents._EasyAEClient
{
    class GetConditionState 
    { 
        public static void Main1()
        {
            // Instantiate the client object.
            var client = new EasyAEClient();

            AEConditionState conditionState;
            try
            {
                conditionState = client.GetConditionState("", "OPCLabs.KitEventServer.2",
                    "Simulation.ConditionState1", "Simulated");
            }
            catch (OpcException opcException)
            {
                Console.WriteLine("*** Failure: {0}", opcException.GetBaseException().Message);
                return;
            }

            Console.WriteLine("ConditionState:");
            Console.WriteLine("    .ActiveSubcondition: {0}", conditionState.ActiveSubcondition);
            Console.WriteLine("    .Enabled: {0}", conditionState.Enabled);
            Console.WriteLine("    .Active: {0}", conditionState.Active);
            Console.WriteLine("    .Acknowledged: {0}", conditionState.Acknowledged);
            Console.WriteLine("    .Quality: {0}", conditionState.Quality);
            // Remark: IAEConditionState has many more properties
        }
    } 
}

' This example shows how to obtain current state information for the condition instance corresponding to a Source and 
' certain ConditionName.

Imports OpcLabs.EasyOpc.AlarmsAndEvents
Imports OpcLabs.EasyOpc.OperationModel

Namespace AlarmsAndEvents._EasyAEClient

    Friend Class GetConditionState
        Public Shared Sub Main1()
            Dim client = New EasyAEClient()

            Dim conditionState As AEConditionState
            Try
                conditionState = client.GetConditionState("", "OPCLabs.KitEventServer.2", "Simulation.ConditionState1", "Simulated")
            Catch opcException As OpcException
                Console.WriteLine("*** Failure: {0}", opcException.GetBaseException().Message)
                Exit Sub
            End Try

            Console.WriteLine("ConditionState:")
            Console.WriteLine("    .ActiveSubcondition: {0}", conditionState.ActiveSubcondition)
            Console.WriteLine("    .Enabled: {0}", conditionState.Enabled)
            Console.WriteLine("    .Active: {0}", conditionState.Active)
            Console.WriteLine("    .Acknowledged: {0}", conditionState.Acknowledged)
            Console.WriteLine("    .Quality: {0}", conditionState.Quality)
            ' Remark: IAEConditionState has many more properties
        End Sub
    End Class

End Namespace

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2012 R2, Windows Server 2016; .NET: Linux, macOS, Microsoft Windows

Reference

EasyAEClient Class
EasyAEClient Members

Send Feedback