Book Creator
 Add this page to your book
Book Creator
 Remove this page from your book  

 Manage book (0 page(s))
 Help

OpcInstanceNodeSnapshot Members

Namespace: Opc.UaFx
Assemblies: Opc.UaFx.Advanced.dll, Opc.UaFx.Advanced.dll
The OpcInstanceNodeSnapshot type exposes the following members.

Properties

Tag

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

C# 

public object Tag { get; set; }


Property Value

Object

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

Methods

Create(OpcContext, OpcInstanceNode)

Creates a new OpcInstanceNodeSnapshot from the node specified.

C# 

public static OpcInstanceNodeSnapshot Create(OpcContext context, OpcInstanceNode node)


Parameters

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

ArgumentNullException

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

Get<T>(OpcAttribute, OpcName)

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

C# 

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


Parameters

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.

Get<T>(OpcAttribute, OpcName[])

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

C# 

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


Parameters

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 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

ArgumentNullException

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

Get<T>(OpcAttribute, OpcNamePath)

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

C# 

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


Parameters

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

ArgumentNullException

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

Get<T>(OpcAttribute, String)

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

C# 

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


Parameters

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.


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.

Get<T>(OpcName)

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

C# 

public T Get<T>(OpcName name)


Parameters

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.

Get<T>(String)

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

C# 

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


Parameters

name String

The String formatted 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.