Rel. 1.01.307.0

[This is preliminary documentation and is subject to change.]

The Opc.Ua namespace contains classes and interfaces which implement all of the types and services defined by the UA specification.

Classes

  ClassDescription
AccessLevels
Flags that can be set for the AccessLevel attribute.
ApplicationAccessRule
An access rule for an application.
ApplicationAccessRuleCollection
A collection of ApplicationAccessRule objects.
ApplicationConfiguration
Stores the configurable configuration information for a UA application.
ApplicationConfigurationSection
Loads the configuration section for an application.
AsyncResultBase
A base class for AsyncResult objects
BaseDataVariableState
A typed base class for all data variable nodes.
BaseDataVariableState<(Of <(T>)>)
A typed base class for all data variable nodes.
BaseDataVariableTypeState
A base class for all data variable type nodes.
BaseDataVariableTypeState<(Of <(T>)>)
A typed base class for all data variable type nodes.
BaseInstanceState
The base class for all instance nodes.
BaseObjectState
The base class for all object nodes.
BaseObjectTypeState
The base class for all object type nodes.
BaseTypeState
The base class for all type nodes.
BaseVariableState
The base class for all variable nodes.
BaseVariableTypeState
The base class for all variable type nodes.
BaseVariableValue
A thread safe object that can be used to access the value of a structure variable.
BinaryDecoder
Decodes objects from a UA Binary encoded stream.
BinaryEncoder
Encodes objects in a stream using the UA Binary encoding.
BindingFactory
A class that manages a mapping between a URL scheme and a binding.
BooleanCollection
A collection of Boolean values.
BrowseNames
Declares all of the BrowseNames used in the Model Design.
ByteCollection
A collection of SByte values.
ByteStringCollection
A collection of ByteString values.
CertificateFactory
Creates a manages certificates.
CertificateIdentifier
The identifier for an X509 certificate.
CertificateIdentifierCollection
A collection of CertificateIdentifier objects.
CertificateStoreIdentifier
Describes a certificate store.
CertificateStoreType
The type of certificate store.
CertificateTrustList
A list of trusted certificates.
CertificateValidationEventArgs
The event arguments provided when a certificate validation error occurs.
CertificateValidator
The identifier for an X509 certificate.
ClientBase
The client side interface with a UA server.
ClientConfiguration
The configuration for a client application.
ConditionStateNames
Defines the default names for the condition states.
ConfigurationLocation
The location of a configuration file.
ConfigurationWatcher
Watches the configuration file and reports any changes.
ConfigurationWatcherEventArgs
Stores the arguments passed when the configuration file changes.
ConfiguredEndpoint
Stores the configuration information for an endpoint.
ConfiguredEndpointCollection
Stores a list of cached enpoints.
DataTypeState
The base class for all reference type nodes.
DataValue
A class that stores the value of variable with an optional status code and timestamps.
DataValueCollection
A collection of DataValues.
DateTimeCollection
A collection of DateTime values.
DiagnosticInfo
Contains diagnostic information associated with a StatusCode.
DiagnosticInfoCollection
A collection of DiagnosticInfo objects.
DirectoryCertificateStore
Provides access to a simple file based certificate store.
DiscoveryServerConfiguration
Specifies the configuration for a discovery server application.
DoubleCollection
A collection of Double values.
EncodeableFactory
Creates encodeable objects based on the type id.
EncodeableObject
A concrete base class used by the autogenerated code.
EncryptedData
Stores a block of encypted data.
EndpointBase
A base class for UA endpoints.
EndpointBase..::.ProcessRequestAsyncResult
An AsyncResult object when handling an asynchronous request.
EndpointBase..::.ServiceDefinition
Stores the definition of a service supported by the server.
EndpointComIdentity
Stores the COM identity for an endpoint.
EventNotifiers
Flags that can be set for the EventNotifier attribute.
ExpandedNodeId
Extends a node id by adding a complete namespace URI.
ExpandedNodeIdCollection
A collection of ExpandedNodeId objects.
ExtensionObject
An object used to wrap data types that the receiver may not understand.
ExtensionObjectCollection
A collection of ExtensionObjects.
FilterContext
Provides context information to used when searching the address space.
FloatCollection
A collection of Float values.
FolderState
The base class for all folder nodes.
FolderTypeState
The base class for all object type nodes.
HierarchyBrowsePath Obsolete.
A browse path defined within an instance declaration hierarchy.
HierarchyReference Obsolete.
A references between nodes in an instance declaration hierarchy.
HiResClock
Produces high resolution timestamps.
IEncodeableCollection
A collection of encodeable objects.
InstanceDeclarationHierarchy Obsolete.
A browse path defined within an instance declaration hierarchy.
InstanceStateSnapshot
A lightweight snapshot of an instance node.
Int16Collection
A collection of Int16 values.
Int32Collection
A collection of Int32 values.
Int64Collection
A collection of Int64 values.
InvokeServiceMessage
The message contract for the InvokeService service.
InvokeServiceResponseMessage
The message contract for the InvokeService service response.
IReferenceDictionary<(Of <(T>)>)
A dictionary designed to provide efficient lookups for references.
LocalizedText
Human readable qualified with a locale.
LocalizedTextCollection
A collection of LocalizedText objects.
Lock
A helper object that can be used in a using() clause to acquire/release a SafeLock.
Matrix
Wraps a multi-dimensional array for use within a Variant.
MessageContextExtension
Uses to add the service message context to the WCF operation context.
MethodState
The base class for all method nodes.
MinimumSamplingIntervals
Constants defined for the MinimumSamplingInterval attribute.
Namespaces
Defines well-known namespaces.
NamespaceTable
The table of namespace uris for a server.
NodeBrowser
A thread safe object which browses the references for an node.
NodeFactory Obsolete.
A class that instantiates nodes based on their type definition.
NodeId
Stores an identifier for a node in a server's address space.
NodeIdCollection
A collection of NodeIds.
NodeIdDictionary<(Of <(T>)>)
A dictionary designed to provide efficient lookups for objects identified by a NodeId
NodeSet
A set of nodes in an address space.
NodeState
The base class for custom nodes.
NodeStateCollection
Stores a collection of nodes.
NodeStateHierarchyReference
Stores a reference from a node in the instance hierarchy.
NodeStateReference
Stores the a reference for a node.
NodeTable
A table of nodes.
Profiles
Common profiles that UA applications may support.
PropertyState
A typed base class for all data variable nodes.
PropertyState<(Of <(T>)>)
A typed base class for all data variable nodes.
PropertyTypeState
A base class for all property variable type nodes.
PropertyTypeState<(Of <(T>)>)
A typed base class for all property variable type nodes.
QualifiedName
A name qualified with a namespace.
QualifiedNameCollection
A collection of QualifiedName objects.
ReadOnlyList<(Of <(T>)>)
A template list class that can be used to expose members of immutable classes.
ReferenceCollection
A table of references for a node.
ReferenceTypeState
The base class for all reference type nodes.
RelativePathFormatter
A class that stores a relative path string
RelativePathFormatter..::.Element
A element in a relative path string.
RsaUtils
Defines functions to implement RSA cryptography.
SafeLock
A class that allows threads to determine who, if anyone, has the lock on an object.
SamplingRateGroup
A class that defines a group of sampling rates supported by the server.
SamplingRateGroupCollection
A collection of SamplingRateGroup objects.
SByteCollection
A collection of SByte values.
SecureChannelContext
Stores context information for the current secure channel.
SecurityAlgorithms
Defines constants for key security policies.
SecurityConfiguration
The security configuration for the application.
SecurityPolicies
Defines constants for key security policies.
ServerBase
A base class for a UA server implementation.
ServerBase..::.RequestQueue
Manages a queue of requests.
ServerBaseConfiguration
Specifies the configuration for a server application.
ServerConfiguration
Specifies the configuration for a server application.
ServerProperties
The properties of the current server instance.
ServerRegistration
Specifies the configuration for a discovery server application.
ServerRegistrationCollection
A collection of AdditionalServerRegistrationInfo objects.
ServerSecurityPolicy
A class that defines a group of sampling rates supported by the server.
ServerSecurityPolicyCollection
A collection of ServerSecurityPolicy objects.
ServiceHost
A host for a UA service.
ServiceMessageContext
Stores context information associated with a UA server that is used during message processing.
ServiceMessageContextBehaviorAttribute
Uses to indicate that a service endpoint uses the UA stack.
ServiceMessageContextMessageInspector
Ensures the operation context is set up correctly.
ServiceResult
A class that combines the status code and diagnostic info structures.
ServiceResultException
An exception thrown when a UA defined error occurs.
StatusCodeCollection
A collection of StatusCodes.
StoreLocations
Constants that identify certificate store locations.
StoreNames
Constants that identify certificate store names.
StringCollection
A collection of String values.
StringTable
A thread safe table of string constants.
SystemContext
A generic implementation for ISystemContext interface.
TraceConfiguration
Specifies parameters used for tracing.
TranslationInfo
Stores the information requires to translate a string.
TransportChannelSettings
Stores the configuration settings for a channel.
TransportConfiguration
Specifies the configuration information for a transport protocol
TransportConfigurationCollection
A collection of TransportConfiguration objects.
TransportListenerSettings
Stores the configuration settings for a channel.
TransportQuotas
Specifies various limits that apply to the transport or secure channel layers.
TypeInfo
Stores information about a type.
TypeInfo..::.Arrays
Constants for one dimensional array types.
TypeInfo..::.Scalars
Constants for scalar types.
TypeTable
Stores the type tree for a server.
UInt16Collection
A collection of UInt16 values.
UInt32Collection
A collection of UInt32 values.
UInt64Collection
A collection of UInt64 values.
UserIdentity
A generic user identity class.
Utils
Defines various static utility functions.
Utils..::.TraceMasks
The masks used to filter trace messages.
UuidCollection
A collection of Uuids.
ValueRanks
Constants defined for the ValueRank attribute.
VariantCollection
A collection of Variant objects.
ViewState
The base class for all view nodes.
ViewTable
The table of all reference types known to the server.
WcfChannelBase
A base class for WCF channel objects used access UA interfaces
WcfChannelBase<(Of <(TChannel>)>)
A base class for WCF channel objects used access UA interfaces
WcfChannelBase<(Of <(TChannel>)>)..::.WcfChannelAsyncResult
An async result object that wraps the WCF channel.
X509AuthorityKeyIdentifierExtension
Stores the authority key identifier extension.
X509SubjectAltNameExtension
Stores the subject alternate name extension.
XmlDecoder
Reads objects from a XML stream.
XmlElementCollection
A collection of XmlElement values.
XmlEncoder
Writes objects to a XML stream.

Structures

  StructureDescription
NumericRange
A class that stores a numeric range.
StatusCode
A numeric code that describes the result of a service or operation.
Uuid
A wrapper for a GUID used during object serialization.
Variant
A structure that could contain value with any of the UA built-in data types.

Interfaces

  InterfaceDescription
ApplicationConfigurationService
A dummy service contract which allows the configuration schema to be exported with svcutil.
ICertificate
An interface to a certificate used by a UA application.
ICertificateStore
An abstract interface to certficate stores.
IChannelBase
The base interface for client proxies.
IChannelOutgoingRequest
An interface to an object that manages a request received from a client.
IDataType
An interface to an object that describes a DataType node.
IDecoder
Defines functions used to dencode objects from a stream.
IEncodeable
Defines methods used to encode and decode objects.
IEncoder
Defines functions used to encode objects in a stream.
IEndpointBase
The base asynchronous interface for all services exposed by UA servers.
IEndpointIncomingRequest
An interface to an object that manages a request received from a client.
IFilterTarget
This interface is used by ContentFilterOperation to get values from the NodeSet for use by the various filter operators. All NodeSets used in a ContentFilter must implement this interface.
ILocalNode
An interface to an object that describes a node local to the server.
IMethod
An interface to an object that describes a DataType node.
INode
An interface to an object that describes a node.
INodeBrowser
An interface to an object that browses the references of an node.
INodeIdFactory
An interface that can be used to create new node ids.
INodeTable
Provides context information to used when evaluating filters.
IObject
An interface to an object that describes an Object node.
IObjectType
An interface to an object that describes an ObjectType node.
IOperationContext
An interface to an object that describes a node local to the server.
IReference
A reference to a node.
IReferenceCollection
A reference to a node.
IReferenceType
An interface to an object that describes a ReferenceType node.
IServerBase
An interface to a service response message.
IServiceHostBase
An interface which the service host object.
IServiceMessage
An interface to a service message.
IServiceRequest
An interface to a service request.
IServiceResponse
An interface to a service response.
ISystemContext
An interface to an object that describes how access the system containing the data.
ITranslatableObject
An interface to a object that can translate itself.
ITranslationManager
An interface to a object that provides translations.
ITransportChannel
This is an interface to a channel which supports
ITransportListener
This is an interface to a listener which supports UA binary encoding.
ITransportListenerCallback
This is an interface to a object that receives notifications from the listener when a message arrives.
ITypeTable
Stores the type tree for a server.
IUserIdentity
An interface to an object with stores the identity of a user.
IVariable
An interface to an object that describes a Variable node.
IVariableBase
An interface to an object that describes either a Variable or a VariableType node.
IVariableType
An interface to an object that describes a VariableType node.
IView
An interface to an object that describes a View node.

Delegates

  DelegateDescription
AlarmConditionShelveEventHandler
Used to recieve notifications when a alarm is shelved or unshelved.
AlarmConditionTimedUnshelveEventHandler
Used to recieve notifications when the timed shelve period elapses for an alarm.
CertificateValidationEventHandler
Used to handled certificate validation errors.
ChannelSendRequestEventHandler
A delegate used to dispatch outgoing service requests.
ConditionAddCommentEventHandler
Used to recieve notifications when a comment is added.
ConditionEnableEventHandler
Used to recieve notifications when a condition is enabled or disabled.
DialogResponseEventHandler
Used to receive notifications when the dialog receives a response.
EndpointBase..::.InvokeServiceEventHandler
A delegate used to dispatch incoming service requests.
GenericMethodCalledEventHandler
Used to process a method call.
NodeAttributeEventHandler<(Of <(T>)>)
Used to receive notifications when a non-value attribute is read or written.
NodeStateChangedHandler
Used to receive notifications when a non-value attribute is read or written.
NodeStateConditionRefreshEventHandler
Used to receive notifications when a node needs to refresh its conditions.
NodeStateConstructDelegate
A delegate which creates a new node.
NodeStatePopulateBrowserEventHandler
Used to receive notifications when a node is browsed.
NodeStateReportEventHandler
Used to receive notifications when a node produces an event.
NodeStateValidateHandler
Used to validate a node.
NodeValueEventHandler
Used to receive notifications when the value attribute is read or written.
NodeValueSimpleEventHandler
Used to receive notifications when the value attribute is read or written.
StateMachineTransitionHandler
A delegate used to recieve notifications when a state machine transition occurs.
TypeInfo..::.CastArrayElementHandler
A delegate for a function that converts an array element.
VariableValueEventHandler
Used to receive notifications when the value attribute is read or written.

Enumerations

  EnumerationDescription
AccessControlType
The rights to an application that may be granted to the user.
AggregateBits
Flags that are set by the historian when returning archived values.
ApplicationAccessRight
The rights to an application that may be granted to the user.
BinaryEncodingSupport
The type of binary encoding support allowed by a channel.
BuiltInType
The set of built-in data types for UA type descriptions.
CertificateValidationOptions
Options that can be used to suppress certificate validation errors.
ComSpecification
The available COM specifications.
CreationRule Obsolete.
The creation rule for a modelling rule.
DiagnosticsMasks
The DiagnosticsMasks enumeration.
EncodingType
The type of encoding used by an encoder/decoder.
EventSeverity
The severity for an event.
ExtensionObjectEncoding
The types of encodings that may used with an object.
LimitAlarmState
The possible states for a limit alarm.
LimitBits
Flags that are set to indicate the limit status of the value.
NamingRule Obsolete.
The naming rule for a modelling rule.
NodeState..::.AttributesToSave
Flags which control the serialization of a NodeState in a stream.
NodeStateChangeMasks
Indicates what has changed in a node.
RelativePathFormatter..::.ElementType
The type of relative path element.
RequestEncoding
The message encoding used with a request.
TransportChannelFeatures
The masks for the optional features which may not be supported by every transport channel.
Utils..::.TraceOutput
The possible trace output mechanisms.
VariableCopyPolicy
Specifies the policies to use when handling reads and write to value.