QuickOPC User's Guide and Reference
_EasyAEClient Interface Members
Properties  Methods 

OpcLabs.EasyOpcClassic Assembly > OpcLabs.EasyOpc.AlarmsAndEvents.ComTypes Namespace : _EasyAEClient Interface

The following tables list the members exposed by _EasyAEClient.

Public Properties
 NameDescription
 PropertyThe alias provider to be used for resolving aliases by this component.  
 PropertyCapacity of the callback queue.  
 PropertyThe idle time before the internal thread executing the queued callbacks is stopped.  
 PropertyCan be used to distinguish otherwise equal widgets.  
 PropertyThe display string for the current object.  
 PropertyContains parameters that influence the behavior of just this instance of the component.  
 PropertySpecifies that you wish that the OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore object instance works with an "isolated" connection to the OPC server, i.e. one that is not shared with other instances.  
 PropertyContains parameters that influence the behavior of the component when it is isolated.  
 PropertyProvides dictionary of license data fields and their values.  
 PropertyCapacity of the event pull queue for notifications.  
 PropertyDetermines whether the component will deliver all callbacks in a queued manner.  
 PropertyGets the OPC technologies supported.  
Top
Public Methods
 NameDescription
 MethodAcknowledges a condition in the Event Server. Uses server descriptor for specifying the OPC server. Use default acknowledger ID and an empty comment.  
 MethodBrowses the specified area for child areas. Uses computer name and server class for specifying the OPC server. A parent area is passed in. No filtering.  
 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.  
 MethodBrowses the specified computer and returns information about OPC (Alarms and Events) servers found.  
 MethodBrowses the specified area for child sources. Uses computer name and server class for specifying the OPC server. A parent area is passed in. No filtering.  
 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.

 
 Method  
 Method  
 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.  
 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.  
 MethodObtains parameters of specified events subscription.  
 Method  
 Method  
 MethodGets the service object of the specified type, given by type name.  
 Method  
 MethodDetermines whether the given event subscription handle is known to this client.  
 MethodAttempts to pull multiple OPC events subscribed to by the OpcLabs.EasyOpc.AlarmsAndEvents.IEasyAEClient.SubscribeEvents method. Returns refresh or standard event notifications.  
 MethodAttempts to pull an OPC event subscribed to by the OpcLabs.EasyOpc.AlarmsAndEvents.IEasyAEClient.SubscribeEvents method. Returns refresh or standard event notifications.  
 MethodAttempts to pull multiple OPC events subscribed to by the OpcLabs.EasyOpc.AlarmsAndEvents.IEasyAEClient.SubscribeEvents method. Returns refresh or standard event notifications.  
 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.

 
 MethodFinds out event conditions associated with the specified source name. Uses server descriptor for specifying the OPC server.  
 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.  
 MethodSets the object properties back to their defaults.  
 MethodSubscribe to OPC events. Specify server descriptor and subscription parameters objects, and "refresh when active" flag.  
 Method  
 MethodUnsubscribe from changes of all OPC events.  
 MethodUnsubscribe from particular OPC event notifications.  
 MethodDefines a generalized method that classes must implement to create type-specific method for determining value equality of instances. Determines whether this instance has the same value as a given other instance.  
Top
See Also

Reference

_EasyAEClient Interface
OpcLabs.EasyOpc.AlarmsAndEvents.ComTypes Namespace