EasyAEClient Class Methods

For a list of all members of this type, see EasyAEClient members.

Public Methods

	Name	Description
	AcknowledgeCondition	Overloaded. 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)
	BrowseNodes	Browses 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)
	BrowseServers	Browses the specified computer and returns information about OPC (Alarms and Events) servers found. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	ChangeEventSubscription	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)
	Clone	Overridden.
	Create	Creates a new instance of the class.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
	Dispose	Overloaded. Clean up any resources being used. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	Equals	(Inherited from object)
	GetConditionState	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. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	GetEventsSubscriptionArguments	Obtains parameters of specified events subscription. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	GetHashCode	Serves as the default hash function. (Inherited from object)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
	GetObjectData	(Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	GetSchema	(Inherited from OpcLabs.BaseLib.Widgets.Widget)
	GetService	(Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	GetType	Gets the System.Type of the current instance. (Inherited from object)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
	IsKnownEventsSubscriptionHandle	Determines whether the given event subscription handle is known to this client. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	PullMultipleNotifications	Attempts to pull multiple OPC events subscribed to by the IEasyAEClient.SubscribeEvents method. Returns refresh or standard event notifications. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	QueryEventCategories	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)
	QuerySourceConditions	Finds out event conditions associated with the specified source name. Uses server descriptor for specifying the OPC server. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	ReadXml	(Inherited from OpcLabs.BaseLib.Widgets.Widget)
	RefreshEventSubscription	Force 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)
	Reset	Sets the object properties back to their defaults. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	SubscribeEvents	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)
	ToString	(Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	UnsubscribeAllEvents	Unsubscribe from changes of all OPC events. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	UnsubscribeEvents	Unsubscribe from particular OPC event notifications. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	ValueEquals	Overloaded. Determines whether the specified EasyAEClientCore is value equal to the current object. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	WriteXml	(Inherited from OpcLabs.BaseLib.Widgets.Widget)

Top

Protected Methods

	Name	Description
	CallbackError	Processes an error that has occurred during a callback. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	Finalize	(Inherited from System.ComponentModel.Component)
	MemberwiseClone	Overloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
	OnContextTypesChanged	Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
	OnNotificationEnqueuerOverflow	Infrastructure. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	OnNotificationEnqueuerOverflowClearing	Infrastructure. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	ReadXmlElement	Infrastructure. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	SendCallbackError	Processes an error that has occurred during a callback. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)
	Synchronize	Overloaded. Invokes the specified action in a synchronized manner. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
	WriteXmlElement	Infrastructure. (Inherited from OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClientCore)

Top

Extension Methods

	Name	Description
	AcknowledgeCondition	Overloaded. 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 client is required to pass the activeTime and cookie received in the event notification to the AcknowledgeCondition method without modification. The server(s) can be local or can be remotely accessed via DCOM.
	AcknowledgeMultipleConditions	Acknowledges multiple conditions in the Event Server.
	BrowseAreas	Overloaded. Browses the specified area (or root) in OPC server's process area space, and returns information about child areas found.
	BrowseNodes	Overloaded. Browses the specified area (or root) in OPC server's process area space, and returns information about child nodes (areas or sources) found.
	BrowseOne	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.
	BrowseServers	Overloaded. Browses for OPC (Alarms&Events) servers.
	BrowseSources	Overloaded. Browses the specified area (or root) in OPC server's process area space, and returns information about child sources found.
	BrowseTree	Overloaded. Allows to traverse through OPC A&E address space nodes under the specified node, using given browse arguments.
	ChangeEventSubscription	Overloaded. Changes parameters of a particular event subscription.
	FindEventCategory	Attempts to find a specified event category in the OPC server, and returns information about it when found.
	FindEventCondition	Attempts to find a specified event condition in the OPC server and for given event category, and returns information about it when found.
	GetConditionState	Overloaded. Returns the current state information for the condition instance corresponding to the source and condition name. Some servers may not maintain sufficient condition state information to fully implement this method. The server(s) can be local or can be remotely accessed via DCOM.
	PullNotification	Attempts to pull an OPC event subscribed to by the IEasyAEClient.SubscribeEvents method. Returns refresh or standard event notifications.
	QueryCategoryAttributes	Overloaded. 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.
	QueryCategoryConditions	Overloaded. Finds out event conditions supported by given event category. Uses server descriptor for specifying the OPC server.
	QueryEventCategories	Overloaded. 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.
	QuerySourceConditions	Finds out event conditions associated with the specified source name. Computer name and server class are used for specifying the OPC server.
	SetState<TNode>	Sets the arbitrary object associated with the node.
	SubscribeEvents	Overloaded. Subscribe to particular OPC events. The IEasyAEClient.Notification is generated for each event.
	SubscribeMultipleEvents	Overloaded. Subscribe to multiple OPC events. 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.
	SupportsTechnology	Determines whether the client object supports a given OPC technology or technologies (such as OPC COM or OPC XML).
	UnsubscribeMultipleEvents	Unsubscribe from changes of multiple OPC events. Unsubscribe from changes of multiple OPC events, specifying array of integer handles.

Top

Reference

EasyAEClient Class
OpcLabs.EasyOpc.AlarmsAndEvents Namespace