OPC Studio User's Guide and Reference
IEasyUAClient Interface Members
Properties  Methods  Events

OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA Namespace : IEasyUAClient Interface

The following tables list the members exposed by IEasyUAClient.

Public Properties
 NameDescription
 PropertyCapacity of the event pull queue for data change notifications.  
 PropertyCapacity of the event pull queue for event notifications.  
Top
Public Methods
 NameDescription
 MethodBrowses multiples nodes in server's address space. Starts from the specified nodes, and returns information about child nodes found.  
 MethodCalls multiple methods, using array of argument objects as an input.  
 MethodChanges parameters of multiple subscriptions, specifying objects containing all necessary arguments.  
 MethodDiscovers available OPC-UA applications or endpoints and returns information about them, using the specified discovery query.  
 MethodObtains parameters of certain monitored item subscription.  
 MethodObtains information about all monitored item subscriptions on this IEasyUAClient object.  
 MethodGets the service object of the specified type. (Inherited from System.IServiceProvider)
 MethodDetermines whether the given monitored item subscription handle is known to this client.  
 MethodAttempts to pull multiple OPC data change notifications subscribed to by the SubscribeMultipleMonitoredItems or SubscribeDataChange method.  
 MethodAttempts to pull multiple OPC event notifications subscribed to by the SubscribeMultipleMonitoredItems or SubscribeEvent method.  
 MethodReads multiple attributes, using array of argument objects as an input.  
 MethodSubscribe to changes of multiple monitored items. The EasyUAClientCore.DataChangeNotification or EasyUAClientCore.EventNotification event is generated for each significant monitored item change.  
 MethodUnsubscribe from changes of all monitored items.  
 MethodUnsubscribe from changes of multiple monitored items, specifying an "enumerable" of integer handles.  
 MethodWrites data into multiple attributes, using array of argument objects as an input.  
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.

This method 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, using the specified GDS endpoint.

This method 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, using the specified GDS endpoint.

This method globally discovers OPC-UA servers and returns information about them, using the specified GDS endpoint, and an empty filter.

Public Extension MethodOverloaded. Discovers OPC-UA applications available on the discovery host.

This method discovers available OPC-UA applications and returns information about them, using the specified discovery host, and filtering by specified application types. It uses the so-called Local Discovery Server (LDS). You can influence how the discovery works using the properties in static EasyUAClientCore.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 OPC-UA servers available on the discovery host.

This method discovers OPC-UA servers and returns information about them, using the specified discovery host. It uses the so-called Local Discovery Server (LDS). You can influence how the discovery works using the properties in static EasyUAClientCore.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.

This method discovers available OPC-UA servers on the network and returns information about them. It uses the so-called Local Discovery Server with Multicast Extensions (LDS-NE). You can influence how the discovery works using the properties in EasyUAClientCore.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, using the specified discovery URI strings.

This method discovers available OPC-UA applications and returns information about them, using the specified discovery URI strings and filtering by specified application types. It 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 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. Retrieves all datatype subtypes.

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. Waits until the attributes satisfy the given conditions.

The WaitForMultiple methods subscribe to the specified nodes&attributes, and monitor their data until the predicates specified for each item become true, or the alloted time elapses.

Public Extension MethodOverloaded. Waits while the attributes are above the given maximum status severity.

The WaitForMultipleValues subscribes to the specified OPC-UA nodes&attributes, and monitor 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. Waits until the specified attribute becomes "good".

The WaitForValue methods subscribe to the specified node&attribute, and monitor 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
 EventRaised for every significant change in a subscribed OPC monitored item.  
 EventRaised when a failure in the eventing infrastructure occurs.  
 EventRaised for every event generated by a subscribed OPC monitored item.  
Top
See Also

Reference

IEasyUAClient Interface
OpcLabs.EasyOpc.UA Namespace