Reference

OpcInstanceNodeSnapshot Members

Type

OpcInstanceNodeSnapshot

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Properties

Tag

Gets or sets the object that contains additional user data about the snapshot.

public object Tag { get; set; }

Public Property Tag As Object

Property value

Object

An object that contains additional user data about the snapshot. The default is null (Nothing in Visual Basic).

Methods

Create

static

Creates a new OpcInstanceNodeSnapshot from the node specified.

public static OpcInstanceNodeSnapshot Create(
    OpcContext context,
    OpcInstanceNode node)

Public Shared Function Create(
    context As OpcContext,
    node As OpcInstanceNode) As OpcInstanceNodeSnapshot

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to collect the snapshot data.
node	OpcInstanceNode	The OpcInstanceNode from which the snapshot data is to be collected.

Returns

OpcInstanceNodeSnapshot

A new instance of the OpcInstanceNodeSnapshot class containing the browsable information of the node specified.

Exceptions

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

Get

6 overloads

Overload	Description
Get<T>(string)	Retrieves the Value attribute of the element browsable through the name specified.
Get<T>(OpcName)since v2.8	Retrieves the Value attribute of the element browsable through the name specified.
Get<T>(OpcAttribute, string)	Retrieves the value of the attribute of the element browsable through the name specified.
Get<T>(OpcAttribute, OpcName)since v2.8	Retrieves the value of the attribute of the element browsable through the name specified.
Get<T>(OpcAttribute, params OpcName[])	Retrieves the value of the attribute of the element browsable through the pathElements specified.
Get<T>(OpcAttribute, OpcNamePath)	Retrieves the value of the attribute of the element browsable through the path specified.

Get<T>(string)

Retrieves the Value attribute of the element browsable through the name specified.

public T Get<T>(string name = "")

Public Function [Get](Of T)(name As String = "") As T

Type parameters

Name	Description
T	The type of the value to query.

Parameters

Name	Type	Description
name	String	The string formatted OpcName to use to browse to the element from that the requested Value attribute is to be retrieved. Optional, default "".

Returns

T

The T of the attribute of the element requested or the default value if the attribute value is not of the type specified by T.

Implements

Get

Get<T>(OpcName)

since v2.8

Retrieves the Value attribute of the element browsable through the name specified.

public T Get<T>(OpcName name)

Public Function [Get](Of T)(name As OpcName) As T

Type parameters

Name	Description
T	The type of value to query.

Parameters

Name	Type	Description
name	OpcName	The OpcName to use to browse to the element from that the requested Value attribute is to be retrieved.

Returns

T

The T of the attribute of the element requested or the default value if the attribute value is not of the type specified by T.

Implements

Get

Get<T>(OpcAttribute, string)

Retrieves the value of the attribute of the element browsable through the name specified.

public T Get<T>(OpcAttribute attribute, string name = "")

Public Function [Get](Of T)(attribute As OpcAttribute, name As String = "") As T

Type parameters

Name	Description
T	The type of value to query.

Parameters

Name	Type	Description
attribute	OpcAttribute	One of the members defined by the OpcAttribute enumeration identifying the attribute value to query from the element specified by the name.
name	String	The string formatted OpcName to use to browse to the element from that the requested attribute value is to be retrieved. Optional, default "".

Returns

T

The T of the attribute of the element requested or the default value if the attribute value is not of the type specified by T.

Implements

Get

Get<T>(OpcAttribute, OpcName)

since v2.8

Retrieves the value of the attribute of the element browsable through the name specified.

public T Get<T>(OpcAttribute attribute, OpcName name)

Public Function [Get](Of T)(attribute As OpcAttribute, name As OpcName) As T

Type parameters

Name	Description
T	The type of value to query.

Parameters

Name	Type	Description
attribute	OpcAttribute	One of the members defined by the OpcAttribute enumeration identifying the attribute value to query from the element specified by the name.
name	OpcName	The OpcName to use to browse to the element from that the requested attribute value is to be retrieved.

Returns

T

The T of the attribute of the element requested or the default value if the attribute value is not of the type specified by T.

Implements

Get

Get<T>(OpcAttribute, params OpcName[])

Retrieves the value of the attribute of the element browsable through the pathElements specified.

public T Get<T>(OpcAttribute attribute, params OpcName[] pathElements)

Public Function [Get](Of T)(
    attribute As OpcAttribute,
    ParamArray pathElements As OpcName()) As T

Type parameters

Name	Description
T	The type of value to query.

Parameters

Name	Type	Description
attribute	OpcAttribute	One of the members defined by the OpcAttribute enumeration identifying the attribute value to query from the element specified by the pathElements.
pathElements	params OpcName[]	The OpcName's to use to browse to the element from that the requested attribute value is to be retrieved.

Returns

T

The T of the attribute of the element requested or the default value if the attribute value is not of the type specified by T.

Exceptions

Exception	Condition
ArgumentNullException	One of the items in pathElements is a null reference (Nothing in Visual Basic).

Implements

Get

Get<T>(OpcAttribute, OpcNamePath)

Retrieves the value of the attribute of the element browsable through the path specified.

public T Get<T>(OpcAttribute attribute, OpcNamePath path)

Public Function [Get](Of T)(attribute As OpcAttribute, path As OpcNamePath) As T

Type parameters

Name	Description
T	The type of value to query.

Parameters

Name	Type	Description
attribute	OpcAttribute	One of the members defined by the OpcAttribute enumeration identifying the attribute value to query from the element specified by the path.
path	OpcNamePath	The sequence OpcName instances to use to browse to the element from that the requested attribute value is to be retrieved.

Returns

T

The T of the attribute of the element requested or the default value if the attribute value is not of the type specified by T.

Exceptions

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

Implements

Get

ToArray

since v2.54

Copies the elements of this data store to a new array.

public object[] ToArray()

Public Function ToArray() As Object()

Returns

Object[]

An object array containing copies of the elements of this data store.

Implements

ToArray