OPC Studio User's Guide and Reference
EasyAEClient Class Members
Properties  Methods  Events


OpcLabs.EasyOpcClassicComponents Assembly > OpcLabs.EasyOpc.AlarmsAndEvents Namespace : EasyAEClient Class

The following tables list the members exposed by EasyAEClient.

Public Constructors
 NameDescription
Public ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyThe alias provider to be used for resolving aliases by this component. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public PropertyCapacity of the callback queue. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public PropertyThe idle time before the internal thread executing the queued callbacks is stopped. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public Property (Inherited from System.ComponentModel.Component)
Public PropertyCan be used to distinguish otherwise equal widgets. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public PropertyContains parameters that influence the behavior of just this instance of the component. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public PropertySpecifies that you wish that the EasyAEClientCore object instance works with an "isolated" connection to the OPC server, i.e. one that is not shared with other instances. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public PropertyContains parameters that influence the behavior of the component when it is isolated. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public PropertyProvides dictionary of license data fields and their values. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public PropertyCapacity of the event pull queue for notifications. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public PropertyDetermines whether the component will deliver all callbacks in a queued manner. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public Propertystatic (Shared in Visual Basic)A default, shared instance of the client object.  
Public Property (Inherited from System.ComponentModel.Component)
Public PropertyGets the OPC technologies supported. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public PropertyContains synchronization context used by the object when performing asynchronous operations (including event notifications). (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Top
Protected Properties
 NameDescription
Protected Property (Inherited from System.ComponentModel.Component)
Protected Property (Inherited from System.ComponentModel.Component)
Protected Property (Inherited from System.ComponentModel.Component)
Protected PropertyThe service container provided by this widget to inheritors. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Public Methods
 NameDescription
Public MethodOverloaded. Acknowledges a condition in the Event Server. Uses server descriptor for specifying the OPC server. Use default acknowledger ID and an empty comment. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodBrowses the specified area (or root) in OPC server's process area space, and returns information about child nodes (areas or sources) found. Uses server descriptor for specifying the OPC server. A parent area descriptor is passed in. No vendor-specific filtering. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodBrowses the specified computer and returns information about OPC (Alarms and Events) servers found. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public Method

Changes parameters of a particular event subscription.

Changes parameters of an event subscription. Specify new notification rate, subscription filter object, and an "active" flag.

(Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodOverridden.   
Public Methodstatic (Shared in Visual Basic)Creates a new instance of the class.  
Public MethodCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodOverloaded. Clean up any resources being used. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public Method (Inherited from object)
Public MethodReturns 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. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodObtains parameters of specified events subscription. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodServes as the default hash function. (Inherited from object)
Public MethodRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public Method (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public Method (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodGets the System.Type of the current instance. (Inherited from object)
Public MethodObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodDetermines whether the given event subscription handle is known to this client. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodAttempts to pull multiple OPC events subscribed to by the IEasyAEClient.SubscribeEvents method. Returns refresh or standard event notifications. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public Method

Finds out events categories supported by the server.

The QueryEventCategories method gives clients a means of finding out the specific categories of events supported by a given server. This method would typically be invoked prior to specifying an event filter. Servers are able to define their own custom event categories, but a list of recommended categories is provided in the OPC specification.

Server descriptor is used for specifying the OPC server. Queries event categories for given event types.

(Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodFinds out event conditions associated with the specified source name. Uses server descriptor for specifying the OPC server. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodRaises a callback or event using a given handler and passing it specified event arguments, optionally specifying whether to enqueue the call. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodForce a refresh for all active conditions and inactive, unacknowledged conditions whose event notifications match the filter of the event subscription.

Clients often need to get the current condition information from the server, particularly at client startup, for things such as a current alarm summary. The OPC Event Server supports this requirement by resending the most recent event notifications which satisfy the filter in the event subscription and which are related to active and/or unacknowledged conditions. The client can then derive the current condition status from the "refreshed" event notifications. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodSets the object properties back to their defaults. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public Method

Subscribe to particular OPC events. The IEasyAEClient.Notification is generated for each event.

Subscribe to particular OPC events, using an object that holds all necessary arguments.

(Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodReturns a string that represents the current object. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodUnsubscribe from changes of all OPC events. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodUnsubscribe from particular OPC event notifications. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public MethodOverloaded. Determines whether the specified EasyAEClientCore is value equal to the current object. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Protected Methods
 NameDescription
Protected MethodProcesses an error that has occurred during a callback. Processes an error that has occurred during a callback. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Protected Method (Inherited from System.ComponentModel.Component)
Protected MethodOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodInfrastructure. Infrastructure. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Protected MethodInfrastructure. Infrastructure. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Protected MethodInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Protected MethodInfrastructure. Infrastructure. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Protected MethodProcesses an error that has occurred during sending of a callback. Processes an error that has occurred during a callback. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Protected MethodOverloaded. Invokes the specified action in a synchronized manner. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Protected MethodInfrastructure. Infrastructure. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded. Acknowledges a condition in the Event Server. The client will receive event notifications (indicating the acknowledgement) from conditions. This method specifically acknowledges the condition becoming active or transitioning into a different sub-condition (and no other state transition of the condition). One or more conditions belong to a specific event source - the source of the event notification. For each condition-related event notification, the corresponding Source, Condition Name, Active Time and Cookie is received by the client as part of the event notification.

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.

The client is required to pass the activeTime and cookie received in the event notification to the AcknowledgeCondition method without modification.

.NET

Public Extension MethodAcknowledges multiple conditions in the Event Server.
Public Extension MethodOverloaded. Browses the specified area (or root) in OPC server's process area space, and returns information about child areas found.

.NET

.NET

Public Extension MethodOverloaded. Browses the specified area (or root) in OPC server's process area space, and returns information about child nodes (areas or sources) found.
Public Extension Method

Browses the nodes in OPC A&E server's address space. Starts from the specified node, and returns information about child nodes found.

Browses the nodes in server's address space, given a browse arguments object.

Public Extension MethodOverloaded. Browses for OPC (Alarms&Events) servers.

.NET

Public Extension MethodOverloaded. Browses the specified area (or root) in OPC server's process area space, and returns information about child sources found.

.NET

.NET

Public Extension MethodOverloaded. Allows to traverse through OPC A&E address space nodes under the specified node, using given browse arguments.
Public Extension MethodOverloaded. Changes parameters of a particular event subscription.

.NET

Public Extension MethodAttempts to find a specified event category in the OPC server, and returns information about it when found.
Public Extension MethodAttempts to find a specified event condition in the OPC server and for given event category, and returns information about it when found.
Public Extension MethodOverloaded. Returns the current state information for the condition instance corresponding to the source and condition name.

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.

.NET

Public Extension MethodAttempts to pull an OPC event subscribed to by the IEasyAEClient.SubscribeEvents method. Returns refresh or standard event notifications.
Public Extension MethodOverloaded. Finds out event attributes that the server can provide as part of an event notification within a given event category. Uses server descriptor for specifying the OPC server.
Public Extension MethodOverloaded. Finds out event conditions supported by given event category. Uses server descriptor for specifying the OPC server.
Public Extension MethodOverloaded. The QueryEventCategories method gives clients a means of finding out the specific categories of events supported by a given server. This method would typically be invoked prior to specifying an event filter. Servers are able to define their own custom event categories, but a list of recommended categories is provided in the OPC specification.

.NET

.NET

Public Extension MethodFinds out event conditions associated with the specified source name. Computer name and server class are used for specifying the OPC server.
Public Extension MethodOverloaded. Subscribe to particular OPC events. The IEasyAEClient.Notification is generated for each event.

.NET

.NET

Public Extension MethodOverloaded. The size of the input array will become the size of the output array. The element positions (indices) in the output array are the same as in the input array. The function returns an array of integer handles. Each such handle uniquely identifies the events subscription. The indices of elements in the output array are the same as those in the input array.
Public Extension MethodDetermines whether the client object supports a given OPC technology or technologies (such as OPC COM or OPC XML).
Public Extension Method

Unsubscribe from changes of multiple OPC events.

Unsubscribe from changes of multiple OPC events, specifying array of integer handles.

Top
Public Events
 NameDescription
Public Event (Inherited from System.ComponentModel.Component)
Public EventRaised when a failure in the eventing infrastructure occurs. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public EventRaised for loggable entries originating in the OPC-A&E client engine and the EasyAEClient component. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Public EventRaised for every OPC event subscribed to by the SubscribeEvents method. This method can be called whether this is a refresh or standard event notification. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
Top
See Also

Reference

EasyAEClient Class
OpcLabs.EasyOpc.AlarmsAndEvents Namespace