Reference

OpcContext Members

Type

OpcContext

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Properties

Current

static · since v2.50

Gets or sets the OpcContext for the current thread.

public static OpcContext Current { get; }

Public Shared ReadOnly Property Current As OpcContext

Property value

OpcContext

The OpcContext that represents the context of the current thread.

Empty

static · since v2.9

Gets an empty OpcContext which can be used in cases there a session nor system specific context is not necessarily required.

public static OpcContext Empty { get; }

Public Shared ReadOnly Property Empty As OpcContext

Property value

OpcContext

An instance of the OpcContext class without any contextual information.

Identity

Gets the OpcUserIdentity which belongs to the situation represented.

public OpcUserIdentity Identity { get; }

Public ReadOnly Property Identity As OpcUserIdentity

Property value

OpcUserIdentity

The OpcUserIdentity which belongs to the situation represented or a null reference (Nothing in Visual Basic) if there is no identity information available.

Namespaces

since v2.12

Gets a read-only collection of namespaces valid in the current OpcContext.

public OpcReadOnlyNamespaceCollection Namespaces { get; }

Public ReadOnly Property Namespaces As OpcReadOnlyNamespaceCollection

Property value

OpcReadOnlyNamespaceCollection

An instance of the OpcReadOnlyNamespaceCollection class with OpcNamespace items for each 'NamespaceUri' used to organize the nodes in an address space.

NodeIdFactory

Gets the OpcNodeIdFactory used to create new node identifiers using this context.

public OpcNodeIdFactory NodeIdFactory { get; }

Public ReadOnly Property NodeIdFactory As OpcNodeIdFactory

Property value

OpcNodeIdFactory

The OpcNodeIdFactory used through this context or a null reference (Nothing in Visual Basic) if there is not node identifier factory associated with this context.

Owner

since v2.11

Gets the owner of the current OpcContext.

public IOpcApplicationInstance Owner { get; }

Public ReadOnly Property Owner As IOpcApplicationInstance

Property value

IOpcApplicationInstance

An instance implementing the IOpcApplicationInstance interface which has defined the current OpcContext.

PreferredLocales

virtual · since v2.11

Gets a collection of preferred locales (see Name) to use to localize data and information.

public virtual OpcLocaleCollection PreferredLocales { get; }

Public Overridable ReadOnly Property PreferredLocales As OpcLocaleCollection

Property value

OpcLocaleCollection

An instance of the OpcLocaleCollection class with Names of the cultures to use to localize data and information in order of this OpcContext.

SessionId

virtual

Gets the session identifier which identifies the session within that the context has been created and is valid.

public virtual OpcNodeId SessionId { get; }

Public Overridable ReadOnly Property SessionId As OpcNodeId

Property value

OpcNodeId

The OpcNodeId of the session.

Methods

Enter

static · 2 overloads · since v2.40

Overload	Description
Enter(params OpcNamespace[])static · since v2.40	Enters a new OpcContext using the namespaces specified.
Enter(IEnumerable<OpcNamespace>)static · since v2.40	Enters a new OpcContext using the namespaces specified.

Enter(params OpcNamespace[])

static · since v2.40

Enters a new OpcContext using the namespaces specified.

public static OpcContext.Local Enter(params OpcNamespace[] namespaces)

Public Shared Function Enter(
    ParamArray namespaces As OpcNamespace()) As OpcContext.Local

Parameters

Name	Type	Description
namespaces	params OpcNamespace[]	An array of OpcNamespace instances known by the Namespaces of the new OpcContext to create.

Returns

OpcContext.Local

A new instance of the OpcContext class.

Enter(IEnumerable<OpcNamespace>)

static · since v2.40

Enters a new OpcContext using the namespaces specified.

public static OpcContext.Local Enter(IEnumerable<OpcNamespace> namespaces)

Public Shared Function Enter(
    namespaces As IEnumerable(Of OpcNamespace)) As OpcContext.Local

Parameters

Name	Type	Description
namespaces	IEnumerable<OpcNamespace>	A sequence of OpcNamespace instances known by the Namespaces of the new OpcContext to create.

Returns

OpcContext.Local

A new instance of the OpcContext class.

GetDataType

6 overloads · since v2.22

Overload	Description
GetDataType(string)since v2.22	Retrieves the OpcDataTypeInfo object which is known under the name specified.
GetDataType(OpcName)since v2.22	Retrieves the OpcDataTypeInfo object which is known under the name specified.
GetDataType(OpcNodeId)since v2.22	Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.
GetDataType(Type)since v2.22	Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.
GetDataType(OpcEncoding)since v2.22	Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.
GetDataType(XmlQualifiedName)since v2.22	Retrieves the OpcDataTypeInfo object which is known under the xmlName specified.

Exceptions (all overloads)

Exception	Condition
ObjectDisposedException	The object has been disposed of.

GetDataType(string)

since v2.22

Retrieves the OpcDataTypeInfo object which is known under the name specified.

public OpcDataTypeInfo GetDataType(string name)

Public Function GetDataType(name As String) As OpcDataTypeInfo

Parameters

Name	Type	Description
name	String	The string to use to identify the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentException	The name is equals Empty.
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetDataType(OpcName)

since v2.22

Retrieves the OpcDataTypeInfo object which is known under the name specified.

public OpcDataTypeInfo GetDataType(OpcName name)

Public Function GetDataType(name As OpcName) As OpcDataTypeInfo

Parameters

Name	Type	Description
name	OpcName	The OpcName of the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetDataType(OpcNodeId)

since v2.22

Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.

public OpcDataTypeInfo GetDataType(OpcNodeId typeId)

Public Function GetDataType(typeId As OpcNodeId) As OpcDataTypeInfo

Parameters

Name	Type	Description
typeId	OpcNodeId	The OpcNodeId which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which is known under the typeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo object which is associated with the typeId specified.

Exceptions

Exception	Condition
ArgumentNullException	The typeId is a null reference (Nothing in Visual Basic).

GetDataType(Type)

since v2.22

Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.

public OpcDataTypeInfo GetDataType(Type underlyingType)

Public Function GetDataType(underlyingType As Type) As OpcDataTypeInfo

Parameters

Name	Type	Description
underlyingType	Type	The Type which implements the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which declares the underlyingType specified or a null reference (Nothing in Visual Basic) if there isn't a OpcDataTypeInfo object associated with the underlyingType specified.

Exceptions

Exception	Condition
ArgumentNullException	The underlyingType is a null reference (Nothing in Visual Basic).

GetDataType(OpcEncoding)

since v2.22

Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.

public OpcDataTypeInfo GetDataType(OpcEncoding encoding)

Public Function GetDataType(encoding As OpcEncoding) As OpcDataTypeInfo

Parameters

Name	Type	Description
encoding	OpcEncoding	The OpcEncoding which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which is known under the encoding specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo which is associated with the encoding specified.

Exceptions

Exception	Condition
ArgumentNullException	The encoding is a null reference (Nothing in Visual Basic).

GetDataType(XmlQualifiedName)

since v2.22

Retrieves the OpcDataTypeInfo object which is known under the xmlName specified.

public OpcDataTypeInfo GetDataType(XmlQualifiedName xmlName)

Public Function GetDataType(xmlName As XmlQualifiedName) As OpcDataTypeInfo

Parameters

Name	Type	Description
xmlName	XmlQualifiedName	The XmlQualifiedName of the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its XmlName is equals to the xmlName specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The xmlName is a null reference (Nothing in Visual Basic).

GetNodeType

4 overloads · since v2.50

Overload	Description
GetNodeType(string)since v2.50	Retrieves the OpcNodeTypeInfo object which is known under the name specified.
GetNodeType(OpcName)since v2.50	Retrieves the OpcNodeTypeInfo object which is known under the name specified.
GetNodeType(OpcNodeId)since v2.50	Retrieves the OpcNodeTypeInfo object which declares the type which is identified by the typeId specified.
GetNodeType(Type)since v2.50	Retrieves the OpcNodeTypeInfo object which declares the type implemented by the underlyingType specified.

Exceptions (all overloads)

Exception	Condition
ObjectDisposedException	The object has been disposed of.

GetNodeType(string)

since v2.50

Retrieves the OpcNodeTypeInfo object which is known under the name specified.

public OpcNodeTypeInfo GetNodeType(string name)

Public Function GetNodeType(name As String) As OpcNodeTypeInfo

Parameters

Name	Type	Description
name	String	The string to use to identify the OpcNodeTypeInfo object to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentException	The name is equals Empty.
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetNodeType(OpcName)

since v2.50

Retrieves the OpcNodeTypeInfo object which is known under the name specified.

public OpcNodeTypeInfo GetNodeType(OpcName name)

Public Function GetNodeType(name As OpcName) As OpcNodeTypeInfo

Parameters

Name	Type	Description
name	OpcName	The OpcName of the OpcNodeTypeInfo object to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetNodeType(OpcNodeId)

since v2.50

Retrieves the OpcNodeTypeInfo object which declares the type which is identified by the typeId specified.

public OpcNodeTypeInfo GetNodeType(OpcNodeId typeId)

Public Function GetNodeType(typeId As OpcNodeId) As OpcNodeTypeInfo

Parameters

Name	Type	Description
typeId	OpcNodeId	The OpcNodeId which identifies the OpcNodeTypeInfo to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object which is known under the typeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcNodeTypeInfo object which is associated with the typeId specified.

Exceptions

Exception	Condition
ArgumentNullException	The typeId is a null reference (Nothing in Visual Basic).

GetNodeType(Type)

since v2.50

Retrieves the OpcNodeTypeInfo object which declares the type implemented by the underlyingType specified.

public OpcNodeTypeInfo GetNodeType(Type underlyingType)

Public Function GetNodeType(underlyingType As Type) As OpcNodeTypeInfo

Parameters

Name	Type	Description
underlyingType	Type	The Type which implements the OpcNodeTypeInfo to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object which declares the underlyingType specified or a null reference (Nothing in Visual Basic) if there isn't a OpcNodeTypeInfo object associated with the underlyingType specified.

Exceptions

Exception	Condition
ArgumentNullException	The underlyingType is a null reference (Nothing in Visual Basic).

OfNode

since v2.50

Creates a context for the node specified which uses the information of the current OpcContext.

public OpcNodeContext OfNode(OpcNode node)

Public Function OfNode(node As OpcNode) As OpcNodeContext

Parameters

Name	Type	Description
node	OpcNode	The OpcNode to that the new context belongs.

Returns

OpcNodeContext

A new instance of the OpcNodeContext class for the node.

Exceptions

Exception	Condition
ArgumentNullException	The node is a null reference (Nothing in Visual Basic).