Package UnifiedAutomation.UaClient

Classes
class	BrowseContext
	The context fr a browse operation. More...
class	CacheManager
	Maintains a local cache of nodes and their attribute values. More...
class	ClientUtils
	Various utility functions for clients. More...
class	DataMonitoredItem
	A data item being monitored. More...
class	Discovery
	The settings for a request. More...
class	ItemEventFilter
	A filter for an Event monitored item. More...
class	SelectClauseCollection
	A collection of select clauses. More...
class	WhereClauseCollection
	A collection of where clauses. More...
class	EventFilterStatus
	The status for an event filter. More...
class	EventMonitoredItem
	A data item being monitored. More...
class	HistoryDataReadResult
	A result for a history data read operation. More...
class	HistoryDataUpdateResult
	A result for a history data update operation. More...
class	HistoryEventReadResult
	A result for a history event read operation. More...
class	HistoryEventUpdateResult
	A result for a history event update operation. More...
class	MetadataMapper
	Provides access to a UA information model using classes with special attributes defined. More...
interface	IMetadataMapper
	An interface that allows the caller to customize the object to UA mapping. More...
class	MetadataMapping
	A object which stores the state of a mapping between a class and a UA information model. More...
class	MetadataHandle
	A handle which can be used to read/write/subscribe to an object. More...
class	MetadataHandleResult
	The result More...
class	MetadataMonitoredItem
	A object which stores the state of a mapping between a class and a UA information model. More...
class	ObjectUpdatedEventArgs
	The event arguments provided when a RepublishError occurs. More...
class	MethodDescription
	Stores the information used to call a method. More...
class	MethodInvocation
	The method invocation. More...
class	ModelManager
	Provides access to a UA information model using classes with special attributes defined. More...
class	MonitoredItem
	An item being monitored. More...
class	PersistentStore
	The settings to use when saving or restoring data in a persistent store. More...
class	RequestSettings
	The settings for a request. More...
class	Session
	A class that manages a session with an OPC UA server. More...
class	ServerConnectionStatusUpdateEventArgs
	The event arguments provided when a session validation error occurs. More...
class	SessionValidationEventArgs
	The event arguments provided when a session validation error occurs. More...
class	UpdateEndpointEventArgs
	The event arguments provided when a endpoint is about to be used to connect to a server. More...
class	Subscription
	A class that manages a subscription with an OPC UA server. More...
class	DataChange
	A data change notification. More...
class	DataChangedEventArgs
	The event arguments provided when a DataChanged occurs. More...
class	NewEvent
	An event notification. More...
class	NewEventsEventArgs
	The event arguments provided when a NewEvents occurs. More...
class	NotificationMessageReceivedEventArgs
	The event arguments provided when a NotificationMessageReceived occurs. More...
class	MissingSequenceNumberEventArgs
	The event arguments provided when a MissingSequenceNumber occurs. More...
class	RepublishErrorEventArgs
	The event arguments provided when a RepublishError occurs. More...
class	SubscriptionStatusChangedEventArgs
	The event arguments provided when a SubscriptionStatusChanged occurs. More...
class	MonitoredItemOperationCompleteEventArgs
	The event arguments provided when a RepublishError occurs. More...
class	TraceClientModuleInfo
	The metadata for the UnifiedAutomation.UaClient trace object. More...
class	TraceClient
	The trace class used by the UnifiedAutomation.UaClient namespace. More...
class	TypeDescription
	The description of a type. More...
class	TypeFieldDescription
	The description of a type field. More...
class	UserIdentity
	A user identity. More...

Enumerations
enum	SecuritySelection { None, BestAvailable }
	The options for selecting security. More...
enum	RetryInitialConnect { No, Yes }
	Whether to retry a failed connect in the background. More...
enum	TypeDescriptionSelection { Basic, FullyInherited }
	The options for selecting the type description. More...
enum	SubscriptionCleanupPolicy { Keep, Delete }
	The options for cleaning up subscriptions. More...
enum	ServerConnectionStatus {   Disconnected = 0, Connected = 1, ConnectionWarningWatchdogTimeout = 2, ConnectionErrorClientReconnect = 3,   ServerShutdownInProgress = 4, ServerShutdown = 5, SessionAutomaticallyRecreated = 6, Connecting = 7,   LicenseExpired = 8 }
	Information about the connection with the server. More...
enum	SubscriptionConnectionStatus {   Deleted, Created, Transferred, WarningKeepAliveLate,   Error }
	The possible states for a subscription. More...
enum	UserIdentityType { Anonymous, UserName, Certificate, Kerberos }
	The possible use identity types. More...

Functions
delegate void	ObjectUpdatedEventHandler (Subscription subscription, ObjectUpdatedEventArgs e)
	Used to report missing messages. More...
delegate void	ServerConnectionStatusUpdateEventHandler (Session sender, ServerConnectionStatusUpdateEventArgs e)
	Used to handled changes to the connection state. More...
delegate void	SessionValidationEventHandler (Session sender, SessionValidationEventArgs e)
	Used to handled session validation errors. More...
delegate void	UpdateEndpointEventHandler (Session sender, UpdateEndpointEventArgs e)
	Used to handled update endpoint events. More...
delegate void	DataChangedEventHandler (Subscription subscription, DataChangedEventArgs e)
	Used to handle DataChanged events. More...
delegate void	NewEventsEventHandler (Subscription subscription, NewEventsEventArgs e)
	Used to handle NewEvents events. Parameters subscription The subscription object that contains the MonitoredItems passed in the NewEvents of e. e The information about the new events. More...
delegate void	NotificationMessageReceivedEventHandler (Subscription subscription, NotificationMessageReceivedEventArgs e)
	Used to handle NotificationMessageReceived events. More...
delegate void	MissingSequenceNumberEventHandler (Subscription subscription, MissingSequenceNumberEventArgs e)
	Used to report missing messages. More...
delegate void	RepublishErrorEventHandler (Subscription subscription, RepublishErrorEventArgs e)
	Used to report missing messages. More...
delegate void	SubscriptionStatusChangedEventHandler (Subscription subscription, SubscriptionStatusChangedEventArgs e)
	Used to report status change events. More...
delegate void	MonitoredItemOperationCompleteEventHandler (Subscription subscription, MonitoredItemOperationCompleteEventArgs e)
	Used to report missing messages. More...

Enumeration Type Documentation

enum UnifiedAutomation.UaClient.UserIdentityType

The possible use identity types.

Enumerator
Anonymous	No user identity is available.
UserName	The user identity is a user name and password.
Certificate	The user identity is an X509 certificate.
Kerberos	The user identity is integrated windows authentication via Kerberos.

Function Documentation

delegate void UnifiedAutomation.UaClient.DataChangedEventHandler	(	Subscription	subscription,
		DataChangedEventArgs	e
	)

Used to handle DataChanged events.

Parameters

subscription	The subscription object that contains the MonitoredItems passed in the DataChanges of e.
e	The information about the changed values.

delegate void UnifiedAutomation.UaClient.MissingSequenceNumberEventHandler	(	Subscription	subscription,
		MissingSequenceNumberEventArgs	e
	)

Used to report missing messages.

Parameters

subscription	The subscription with missing sequence numbers.
e	The sequence number information.

delegate void UnifiedAutomation.UaClient.MonitoredItemOperationCompleteEventHandler	(	Subscription	subscription,
		MonitoredItemOperationCompleteEventArgs	e
	)

Used to report missing messages.

delegate void UnifiedAutomation.UaClient.NewEventsEventHandler	(	Subscription	subscription,
		NewEventsEventArgs	e
	)

Used to handle NewEvents events.

Parameters

subscription	The subscription object that contains the MonitoredItems passed in the NewEvents of e.
e	The information about the new events.

delegate void UnifiedAutomation.UaClient.NotificationMessageReceivedEventHandler	(	Subscription	subscription,
		NotificationMessageReceivedEventArgs	e
	)

Used to handle NotificationMessageReceived events.

Parameters

subscription	The subscription.
e	The UnifiedAutomation.UaClient.NotificationMessageReceivedEventArgs instance containing the event data.

delegate void UnifiedAutomation.UaClient.ObjectUpdatedEventHandler	(	Subscription	subscription,
		ObjectUpdatedEventArgs	e
	)

Used to report missing messages.

delegate void UnifiedAutomation.UaClient.RepublishErrorEventHandler	(	Subscription	subscription,
		RepublishErrorEventArgs	e
	)

Used to report missing messages.

delegate void UnifiedAutomation.UaClient.ServerConnectionStatusUpdateEventHandler	(	Session	sender,
		ServerConnectionStatusUpdateEventArgs	e
	)

Used to handled changes to the connection state.

delegate void UnifiedAutomation.UaClient.SessionValidationEventHandler	(	Session	sender,
		SessionValidationEventArgs	e
	)

Used to handled session validation errors.

delegate void UnifiedAutomation.UaClient.SubscriptionStatusChangedEventHandler	(	Subscription	subscription,
		SubscriptionStatusChangedEventArgs	e
	)

Used to report status change events.

delegate void UnifiedAutomation.UaClient.UpdateEndpointEventHandler	(	Session	sender,
		UpdateEndpointEventArgs	e
	)

Used to handled update endpoint events.