Reference

OpcReadOnlyNodeCollection Members

Type

OpcReadOnlyNodeCollection

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Properties

Count

Gets the number of nodes contained in the OpcReadOnlyNodeCollection instance.

public int Count { get; }

Public ReadOnly Property Count As Integer

Property value

Int32

The number of nodes contained in the OpcReadOnlyNodeCollection instance.

Implements

Count, Count

Empty

static

Gets an empty instance used in cases there the concrete collection does not yet exists.

public static OpcReadOnlyNodeCollection Empty { get; }

Public Shared ReadOnly Property Empty As OpcReadOnlyNodeCollection

Property value

OpcReadOnlyNodeCollection

An instance of the OpcReadOnlyNodeCollection which can be used for general purpose in cases there an empty collection is required.

Items

protected

Gets the IList<T> that the OpcReadOnlyNodeCollection wraps.

protected IList<IOpcNode> Items { get; }

Protected ReadOnly Property Items As IList(Of IOpcNode)

Property value

IList<IOpcNode>

The IList<T> that the OpcReadOnlyNodeCollection wraps.

Methods

Contains

2 overloads

Overload	Description
Contains(IOpcNode)	Determines whether a node is in the OpcReadOnlyNodeCollection.
Contains(OpcNodeId)	Determines whether a node with the id specified is in the OpcReadOnlyNodeCollection.

Contains(IOpcNode)

Determines whether a node is in the OpcReadOnlyNodeCollection.

public bool Contains(IOpcNode value)

Public Function Contains(value As IOpcNode) As Boolean

Parameters

Name	Type	Description
value	IOpcNode	The object to locate in the OpcReadOnlyNodeCollection.

Returns

Boolean

The value true if value is found in the OpcReadOnlyNodeCollection; otherwise, the value false.

Exceptions

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

Implements

Contains(IOpcNode)

Contains(OpcNodeId)

Determines whether a node with the id specified is in the OpcReadOnlyNodeCollection.

public bool Contains(OpcNodeId id)

Public Function Contains(id As OpcNodeId) As Boolean

Parameters

Name	Type	Description
id	OpcNodeId	The OpcNodeId to use to look up a existing node.

Returns

Boolean

The value true if a node exists in the OpcReadOnlyNodeCollection with the id; otherwise, the value false.

Exceptions

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

CopyTo

Copies the entire OpcReadOnlyNodeCollection to a compatible one-dimensional Array, starting at the specified index of the target array.

public void CopyTo(IOpcNode[] array, int index)

Public Sub CopyTo(array As IOpcNode(), index As Integer)

Parameters

Name	Type	Description
array	IOpcNode[]	The one-dimensional Array that is the destination of the elements copied from OpcReadOnlyNodeCollection. The Array must have zero-based indexing.
index	Int32	The zero-based index in array at which copying begins.

Exceptions

Exception	Condition
ArgumentException	The number of elements in the source OpcReadOnlyNodeCollection is greater than the available space from index to the end of the destination array.
ArgumentNullException	The array is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeException	The index is less than zero.

Implements

CopyTo(IOpcNode[], int)

GetEnumerator

Returns an enumerator that iterates through the OpcReadOnlyNodeCollection.

public IEnumerator<IOpcNode> GetEnumerator()

Public Function GetEnumerator() As IEnumerator(Of IOpcNode)

Returns

IEnumerator<IOpcNode>

An IEnumerator<T> for the OpcReadOnlyNodeCollection.

Implements

GetEnumerator()

IndexOf

Searches for the specified object and returns the zero-based index of the first occurrence within the entire OpcReadOnlyNodeCollection.

public int IndexOf(IOpcNode value)

Public Function IndexOf(value As IOpcNode) As Integer

Parameters

Name	Type	Description
value	IOpcNode	The node to locate in the OpcReadOnlyNodeCollection.

Returns

Int32

The zero-based index of the first occurrence of item within the entire value, if found; otherwise the value -1.

Exceptions

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

Implements

IndexOf(IOpcNode)

TryGet

since v2.15

Tries to determine the item associated with the specified id.

public bool TryGet(OpcNodeId id, out IOpcNode node)

Public Function TryGet(id As OpcNodeId, node As IOpcNode) As Boolean

Parameters

Name	Type	Description
id	OpcNodeId	The OpcNodeId whose IOpcNode item to get.
node	out IOpcNode	When this method returns, the IOpcNode associated with the specified id, if the id is found; otherwise, a null reference (Nothing in Visual Basic).

Returns

Boolean

Exceptions

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

Indexers

Item

2 overloads

Overload	Description
this[int]	Gets the node at the specified index.
this[OpcNodeId]	Gets the node at the specified index.

this[int]

Gets the node at the specified index.

public IOpcNode this[int index] { get; }

Public ReadOnly Default Property this[](index As Integer) As IOpcNode

Parameters

Name	Type	Description
index	Int32	The zero-based index of the node to get.

Property value

IOpcNode

The node at the specified index.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The index is not valid index in the OpcReadOnlyNodeCollection.

this[OpcNodeId]

Gets the node at the specified index.

public IOpcNode this[OpcNodeId id] { get; }

Public ReadOnly Default Property this[](id As OpcNodeId) As IOpcNode

Parameters

Name	Type	Description
id	OpcNodeId	The OpcNodeId of the node to get.

Property value

IOpcNode

The node with the specified id.

Exceptions

Exception	Condition
KeyNotFoundException	The id does not refer to a node with such an Id.