QuickOPC User's Guide and Reference
EasyUAClient Class Members
Fields  Properties  Methods  Events


OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA Namespace : EasyUAClient Class

The following tables list the members exposed by EasyUAClient.

Public Constructors
 NameDescription
Public ConstructorOverloaded.   
Top
Public Fields
 NameDescription
Public FieldDefault value of the Isolated property. Equals to false.  
Top
Public Properties
 NameDescription
Public Propertystatic (Shared in Visual Basic)Adaptable parameters for non-isolated client objects.  
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.  
Public PropertySpecifies that you wish that the EasyUAClient object instance works with an "isolated" connection to the OPC-UA server, i.e. one that is not shared with other instances.  
Public PropertyContains parameters that influence the behavior of the component when it is isolated.  
Public PropertyProvides dictionary of license data fields and their values.  
Public PropertyCapacity of the event pull queue for data change notifications.  
Public PropertyCapacity of the event pull queue for event notifications.  
Public PropertyCapacity of the event pull queue for server condition changes.  
Public PropertyDetermines whether the component will deliver all callbacks in a queued manner.  
Public Propertystatic (Shared in Visual Basic)A shared instance of the client object.  
Public Propertystatic (Shared in Visual Basic)Parameters that are always shared by all instances of the component.  
Public Propertystatic (Shared in Visual Basic)Container for services that are shared by all instances of the component.  
Public Propertystatic (Shared in Visual Basic)Provides services that are shared by all instances of the component.  
Public Property (Inherited from System.ComponentModel.Component)
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 MethodBrowses multiples nodes in server's address space. Starts from the specified nodes, and returns information about child nodes found.  
Public MethodCalls multiple methods, using array of argument objects as an input.  
Public MethodChanges parameters of multiple subscriptions, specifying objects containing all necessary arguments.  
Public Methodstatic (Shared in Visual Basic)Clears the list of validated certificates kept by the component.  
Public MethodOverridden.   
Public Methodstatic (Shared in Visual Basic)Closes all unused sessions that are open to OPC-UA servers.  
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 MethodDiscovers available OPC-UA applications or endpoints and returns information about them, using the specified discovery query.  
Public MethodOverloaded. Globally discovers OPC-UA servers and returns information about them, using an empty filter, and the default GDS endpoint.  
Public MethodDiscovers available OPC-UA servers and returns information about them, using the default discovery host.  
Public MethodOverloaded. Discovers available OPC-UA servers on the network and returns information about them, using the default discovery host.  
Public MethodOverloaded. Overridden. Clean up any resources being used.  
Public Method (Inherited from object)
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 MethodObtains parameters of certain monitored item subscription.  
Public MethodObtains parameters of certain monitored item subscription.  
Public MethodOverridden.   
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodOverridden.   
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 Methodstatic (Shared in Visual Basic)Creates an application instance certificate if it does not exist.  
Public MethodDetermines whether the given monitored item subscription handle is known to this client.  
Public MethodAttempts to pull multiple OPC data change notifications subscribed to by the SubscribeMultipleMonitoredItems or SubscribeDataChange method.  
Public MethodAttempts to pull multiple OPC event notifications subscribed to by the SubscribeMultipleMonitoredItems or SubscribeEvent method.  
Public MethodAttempts to pull multiple OPC server condition changed events.  
Public MethodOverloaded. Raises a callback or event using a given handler and passing it specified event arguments. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public MethodReads multiple attributes, using array of argument objects as an input.  
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodSets the object properties back to their defaults.  
Public Methodstatic (Shared in Visual Basic)Forces a retrial on all objects that are in a failure state.  
Public MethodSubscribe to changes of multiple monitored items. The DataChangeNotification or EventNotification event is generated for each significant monitored item change.  
Public MethodOverridden. Returns a string that represents the current object.  
Public Methodstatic (Shared in Visual Basic)Reverts the changes made by Install method.  
Public MethodUnsubscribe from changes of all monitored items.  
Public MethodUnsubscribe from changes of multiple monitored items, specifying an enumerable of integer handles.  
Public MethodOverloaded. Determines whether this object is value equal to the other.  
Public MethodWrites data into multiple attributes, using array of argument objects as an input.  
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Protected Methods
 NameDescription
Protected MethodOverridden. Processes an error that has occurred during a callback. Processes an error that has occurred during a callback.  
Protected Method (Inherited from System.ComponentModel.Component)
Protected MethodOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOverridden. Infrastructure. Infrastructure.  
Protected MethodOverridden. Infrastructure. Infrastructure.  
Protected MethodInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Protected MethodOverridden. Infrastructure. Infrastructure.  
Protected MethodOverridden. Processes an error that has occurred during sending of a callback. Processes an error that has occurred during a callback.  
Protected MethodOverloaded. Invokes the specified action in a synchronized manner. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Protected MethodOverridden. Infrastructure. Infrastructure.  
Top
Extension Methods
 NameDescription
Public Extension MethodDerives an OPC UA global discovery client object from the current client object.
Public Extension MethodDerives an OPC UA certificate management client object from the current client object.
Public Extension MethodDerives an OPC UA file transfer client object from the current client object.
Public Extension MethodDerives an OPC UA global discovery client object from the current client object.
Public Extension MethodDerives an OPC UA publish-subscribe client object from the current client object.
Public Extension MethodOverloaded. Browses the nodes in server's address space, given the browse arguments.
Public Extension MethodOverloaded. Browses the data nodes in OPC server's address space. Starts from the specified node (or Objects folder), and returns information about child nodes found.
Public Extension MethodOverloaded. Browses the Data Variables in OPC server's address space. Starts from the specified node (or Objects folder), and returns information about child nodes found.
Public Extension MethodOverloaded. Browses the EventSources in OPC server's address space. Starts from the specified node (or EventSources folder), and returns information about child nodes found.
Public Extension MethodOverloaded. Browses the Methods in OPC server's address space. Starts from the specified node (or Objects folder), and returns information about child nodes found.
Public Extension MethodOverloaded. Browses the Notifiers in OPC server's address space. Starts from the specified node (or Notifiers folder), and returns information about child nodes found.
Public Extension MethodOverloaded. Browses the Objects in OPC server's address space. Starts from the specified node (or Objects folder), and returns information about child nodes found.
Public Extension MethodOverloaded. Browses the ObjectTypes in OPC server's address space. Starts from the specified node (or ObjectTypes folder), and returns information about child nodes found.
Public Extension MethodOverloaded. Browses the nodes in server's address space. Starts from the specified node, and returns information about child nodes found.
Public Extension MethodOverloaded. Browses the Properties in OPC server's address space. Starts from the specified node (or Objects folder), and returns information about child nodes found.
Public Extension MethodOverloaded. Allows to traverse through OPC UA address space nodes under the specified node, using given browse arguments.
Public Extension MethodOverloaded. Browses the Variables in OPC server's address space. Starts from the specified node (or Objects folder), and returns information about child nodes found.
Public Extension MethodOverloaded. Calls (invokes) a method (or methods) in an OPC server. Input and output arguments can be passed to/from methods.
Public Extension MethodChanges parameters of a data change subscription. Specify the handle, a new sampling interval and absolute deadband value.
Public Extension MethodOverloaded. Changes parameters of a subscription to a particular monitored item.

It is more efficient to change multiple subscriptions using MultipleMonitoredItemSubscriptions method.

Public Extension MethodChanges parameters of multiple data change subscriptions. Specify the handles, a new sampling interval and absolute deadband value.
Public Extension MethodOverloaded. Changes parameters of multiple subscriptions. Specify the handles, and a new sampling interval.
Public Extension MethodOverloaded. Globally discovers OPC-UA applications that meet the specified filters and returns information about them, using the specified GDS endpoint.
Public Extension MethodOverloaded. Globally discovers OPC-UA servers and returns information about them, using the specified GDS endpoint, and an empty filter.
Public Extension MethodOverloaded. Discovers available OPC-UA applications and returns information about them, using the specified discovery host, and filtering by specified application types.

This method uses the so-called Local Discovery Server (LDS). You can influence how the discovery works using the properties in static EasyUAClient.SharedParameters.

Invokes the FindServers service.

See also in Knowledge Base: Technical note-OPC UA Discovery in QuickOPC.

Public Extension MethodOverloaded. Discovers available endpoints for a given server discovery URL.

The query is performed using a GetEndpoints service of an OPC server specified by its discovery endpoint.

See also in Knowledge Base: Technical note-OPC UA Discovery in QuickOPC.

Public Extension MethodOverloaded. Discovers available OPC-UA servers and returns information about them, using the specified discovery host.

This method uses the so-called Local Discovery Server (LDS). You can influence how the discovery works using the properties in static EasyUAClient.SharedParameters.

Invokes the FindServers service.

See also in Knowledge Base: Technical note-OPC UA Discovery in QuickOPC.

Public Extension MethodOverloaded. Discovers available OPC-UA servers on the network and returns information about them.

This method uses the so-called Local Discovery Server with Multicast Extensions (LDS-NE). You can influence how the discovery works using the properties in EasyUAClient.SharedParameters.

Invokes the FindServersOnNetwork service.

See also in Knowledge Base: Technical note-OPC UA Discovery in QuickOPC.

Public Extension MethodOverloaded. Discovers available OPC-UA applications and returns information about them, using the specified discovery URI strings and filtering by specified application types.

This method uses the discovery services on specified discovery endpoints.

Invokes the FindServers service.

The discovery may be attempted in parallel on the specified endpoints, depending on component settings.

See also in Knowledge Base: Technical note-OPC UA Discovery in QuickOPC.

Public Extension MethodAttempts to pull an OPC data change notification subscribed to by the SubscribeMultipleMonitoredItems or SubscribeDataChange method.
Public Extension MethodAttempts to pull an OPC event notification subscribed to by the SubscribeMultipleMonitoredItems or SubscribeEvent method.
Public Extension MethodAttempts to pull an OPC server condition changed event.
Public Extension MethodOverloaded. Reads attribute data from an OPC server. Value, status code, and timestamps are returned.
Public Extension MethodOverloaded. Reads a value of DataType attribute of a node.If successful, the method returns the actual value of OPC attribute requested.

This method also checks whether the returned value is not a reference, and is indeed of the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId type. The returned value is therefore always a valid OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.

Public Extension MethodOverloaded. Reads a value of DisplayName attribute of a node.If successful, the method returns the actual value of OPC attribute requested.

This method also checks whether the returned value is not a reference, and is indeed of the System.String type. The returned value is therefore always a valid System.String.

Public Extension MethodOverloaded. Reads values of multiple attributes.
Public Extension MethodReads value of DataType attribute of multiple nodes, using array of argument objects as an input.
Public Extension MethodReads value of DisplayName attribute of multiple nodes, using array of argument objects as an input.
Public Extension MethodReads value of NodeClass attribute of multiple nodes, using array of argument objects as an input.
Public Extension MethodReads value of NodeId attribute of multiple nodes, using array of argument objects as an input.
Public Extension MethodOverloaded. Reads values of multiple attributes.
Public Extension MethodOverloaded. Reads a value of NodeClass attribute of a node.If successful, the method returns the actual value of OPC attribute requested.

This method also checks whether the returned value is not a reference, and is indeed of the OpcLabs.EasyOpc.UA.AddressSpace.UANodeClass type. The returned value is therefore always a valid OpcLabs.EasyOpc.UA.AddressSpace.UANodeClass.

Public Extension MethodOverloaded. Reads a value of NodeId attribute of a node.If successful, the method returns the actual value of OPC attribute requested.

This method also checks whether the returned value is not a reference, and is indeed of the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId type. The returned value is therefore always a valid OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.

Public Extension MethodOverloaded. Reads an attribute from an OPC server. Only the attribute's value is returned (status code and timestamps are not returned).The status code must be 'good' for this method to succeed; otherwise, a OpcLabs.EasyOpc.UA.OperationModel.UAException is thrown.
Public Extension MethodOverloaded. 

The starting node is included as the first element in the result value.

Public Extension MethodOverloaded. Subscribe to a data change. Specify an endpoint descriptor, node id, and sampling interval.
Public Extension MethodOverloaded. Subscribe to an event. Specify an endpoint descriptor, node id, and sampling interval.
Public Extension MethodOverloaded. Subscribe to changes of a particular monitored item. For each significant monitored item change, either the IEasyUAClient.DataChangeNotification event is generated, or a specified callback method is invoked.

It is more efficient to subscribe to multiple monitored items using SubscribeMultipleMonitoredItems method.

Public Extension MethodSubscribe to changes of multiple OPC monitored items with a data change callback method. The IEasyUAClient.DataChangeNotification event will be generated for each significant item change, and a specified callback method will be invoked.
Public Extension MethodSubscribe to changes of multiple OPC monitored items with an event notification callback method. The IEasyUAClient.EventNotification event will be generated for each significant item change, and a specified callback method will be invoked.
Public Extension MethodSubscribe to changes of multiple OPC monitored items. The IEasyUAClient.DataChangeNotification or IEasyUAClient.EventNotification event will be generated for each significant item change.
Public Extension MethodTests whether an operational connection can be established to the specified endpoint of an OPC UA server.
Public Extension MethodUnsubscribe from changes of a particular monitored item.

Unsubscribe from monitored item, specifying its handle.

Public Extension MethodOverloaded. Subscribes to the specified nodes&attributes, and monitors their data until the predicates specified for each item become true, or the alloted time elapses.
Public Extension MethodOverloaded. Subscribes to the specified OPC-UA nodes&attributes, and monitors their data until they have at most the status severity specified for each item, an error occurs, or the alloted time elapses.
Public Extension MethodOverloaded. Subscribes to the specified node&attribute, and monitors its data until it has "good" status severity, an error occurs, or the alloted time elapses.
Public Extension MethodOverloaded. Writes into an attribute in an OPC server. Value, status code and timestamps are written.
Public Extension MethodWrites values into multiple attributes, using array of argument objects as an input (status codes and timestamps are not written).
Public Extension MethodOverloaded. Writes a value into an attribute an OPC server. Only the item value is written (status code and timestamps are not written).
Top
Public Events
 NameDescription
Public EventRaised for every significant change in a subscribed OPC monitored item.  
Public Event (Inherited from System.ComponentModel.Component)
Public EventRaised when a failure in the eventing infrastructure occurs.  
Public EventRaised for every event generated by a subscribed OPC monitored item.  
Public EventRaised for loggable entries originating in the OPC-UA client engine and the EasyUAClient component.  
Public EventRaised for a change in the condition of an OPC server.  
Top
See Also

Reference

EasyUAClient Class
OpcLabs.EasyOpc.UA Namespace