UA Client SDK that provides a set of .NET classes that handle the UA server access.
DA, HD, AC and Methods are supported.
The main class is UAClient. It has methods to find UA servers and create sessions with servers.
Classes
| Class | Description | |
|---|---|---|
 | Browser | Helper class for browsing UA nodes. The many browse options are defined in properties with default values for hierarchical browsing. |
| Browser.BrowserEventArgs | The event arguments provided a browse operation returns a continuation point. |
| BrowseTree | The methods in this class simplify the browsing of the UA server's address space. The browse result is returned in a TreeNode array that can directly be used with a Windows TreeView control. TreeNode.Text holds the UA node display name. TreeNode.Tag holds a NodeElement object with the details of the UA node and it's forward references. The class of the UA nodes are shown with icons. For VARIABLE class nodes the accrees right and value data type are read and stored in teh NodeElement object. The read/write access right is indicated with icons, eith for DA or HD access, depending on the property ShowHDaccessRights. |
| CertificatePermissions | Helper methods for certificate access rights management. |
| ConfigUtils | |
| DataBindEventData | Data object passed to the user data change event handler. |
| DataBindFormat | Holds the definitions how to transformn and format a value. |
| DataDictionary | A class that holds the configuration for a UA service. |
| DBLink | DataBind link data for one item. |
| FilterDefinition | Defines a event filter for a subscription. |
| HistoryDataReadResult | A result for a history data read operation. |
| HistoryDataUpdateResult | A result for a history data update operation. |
| HistoryEventReadResult | A result for a history event read operation. |
| HistoryEventUpdateResult | A result for a history event update operation. |
| Images | Image list used in the BrowseTree methods to display icons in the TreeView and ListView dialogs. |
| InnerSession | Manages a session with a UA server. |
| MonitoredItem | A monitored item. |
| MonitoredItemDataCache | An item in the cache |
| MonitoredItemEventCache | Saves the events received from the srever. |
| MonitoredItemNotificationEventArgs | The event arguments provided when a new notification message arrives. |
| MonitoredItemStatus | The current status of monitored item. |
| NamespaceMapper | A class that manages the mapping between the local and remote namespace indexes. |
| NodeElement | Holds the details of the UA node associated with the TreeNode object. In the BrowseTree class the TreeNode.Tag property holds the NodeElement object. |
| NotificationEventArgs | Represents the event arguments provided when a new notification message arrives. |
| PublishErrorEventArgs | Represents the event arguments provided when a publish error occurs. |
| PublishStatusChangedArgs | Holds the data passed to the PublishStatusChanged event handler |
| RequestSettings | The settings for a request. |
| ServerCapabilities | Server capabilities name definition |
| Session | Manages a session with a server. Manages a session with a UA server. |
| SessionReconnectHandler | Attempts to reconnect to the server. |
| ShowBrowseTree | The OPC UA server is browsed using the BrowseTree class and all nodes are hierarchically displayed in a TreeView control. TreeNode.Text holds the UA node display name. TreeNode.Tag holds a NodeElement object with the details of the UA node. |
| ShowBrowseTreeList | The UA server is browsed and all nodes are displayed in a TreeView control. The Variable class nodes of the selected TreeView node are displayed in the ListView. In the ListView multiple nodes can be selected while the TreeView only allows selection a single node. Node images are displayed as shown in the picture. The user can select other images or supply his own ImageList. In default mode, the server is browsed as needed, initially the root level and each branch when it is selected for the first time. This results in a short latency, even for servers with a large address space. The BrowseTreeList object's BowseModeOneLevel property can be set to false, to force browsing all levels in the first call. TreeNode.Text holds the UA node display name. TreeNode.Tag holds a NodeElement object with the details of the UA node and the details of the child nodes. |
| StatusCheckEventArgs | The event arguments provided when a keep alive response arrives. |
| Subscription | UA Subscriptions have a set of MonitoredItems assigned to them by the Client. MonitoredItems generate Notifications that are reported to the Client by the Subscription. The Subscriptions have a publishing interval. The publishing interval of a Subscription defines the cyclic rate at which the Subscription executes. Each time it executes, it attempts to send a NotificationMessage to the Client. NotificationMessages contain Notifications that have not yet been reported to Client. NotificationMessages are sent to the Client in response to Publish requests. Publish requests are normally queued to the Session as they are received, and one is de-queued and processed by a subscription related to this Session for each publishing cycle, if there are Notifications to report. When there are not, the Publish request is not de-queued from the Session, and the Server waits until the next cycle and checks again for Notifications. |
| SubscriptionCollection | A collection of subscriptions. |
| SubscriptionStateChangedEventArgs | The event arguments provided when the state of a subscription changes. |
| SubscriptionTemplate | Holds the parameters of a subscription instance. |
| SubscriptionTemplateCollection | A list of subscription template objects |
| UaArgument | Defines an input or output argument of a UA Method. GetUaMethodDefinition() returns UaArgument objects in lists for inpout and output argements. |
| UaClient | Main class of the EasyUA client component. The client application creates an instance of this class to enumerate and access UA servers. |
| UaDataBind | Class for automatic display and refresh of item values in Windows controls. |
| UaMethodArguments | GetUaMethodDefinition() returns the result in an object of this class. |
| UriTable | Class used for persisting the UA server URI tables. |
Delegates
| Delegate | Description | |
|---|---|---|
 | Browser.OnBrowseCompleted | Aync callback with the browse result. |
| Browser.OnBrowser | A delegate used to received browser events. |
| DataBindCallbackUserHandler | DataBind value change callback handler for one item. If such a handler is defined for a subscription then this candler is called from the DataBind server callback handling in place of the default handling. The DataBind server callback handler does the Invoke handling for Windows thread synchronization and then calls this handler for each item in the server callback. The handler is true if the item is handled. Otherwise the default DataBind server callback handler will try to handle the callback for this item. |
| OnBrowseError | The OnBrowseError handler is called when an error happens in the server browse access from the TreeView mouse event handler. |
| OnCreateSessionComplete | Create session complete callback handler |
| OnDataBind | Callback handler that can be assigned to a subscription in place of a Windows control. The user can handle data change callbacks individually for each item. |
| OnDataBindCallbackError | Callback handler that can be assigned to a subscription in place of a Windows control. The user can handle data change callbacks individually for each item. |
| OnDataBindCallbackError2 | Callback handler that can be assigned to a subscription in place of a Windows control. The user can handle data change callbacks individually for each item. |
| OnDataChangeNotification | The delegate used to receive data change notifications via a direct function call instead of a .NET Event. |
| OnEventNotification | The delegate used to receive event notifications via a direct function call instead of a .NET Event. |
| OnMonitoredItemNotification | The delegate used to receive monitored item value notifications. |
| OnNotification | The delegate used to receive publish notifications. |
| OnNotifyUntrustedCertificate | Event handler called when the server certificate is untrusted |
| OnPublishError | The delegate used to receive pubish error notifications. |
| OnRenewUserIdentity | Used to handle renews of user identity tokens before reconnect. |
| OnStatusChange | The delegate used to receive keep alive notifications. |
| OnSubscriptionStateChanged | The delegate used to receive subscription state change notifications. |
| Subscription.OnCreateComplete | The asynchronous Subscription create completion callback handler. |
Enumerations
| Enumeration | Description | |
|---|---|---|
 | ServerConnectionStatus | Information about the connection with the server. |
| SubscriptionChangeMask | Flags indicating what has changed in a subscription. |