Reference

OpcName Members

Type

OpcName

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcName

3 overloads

Overload	Description
OpcName(string)	Initializes a new instance of the OpcName class using the value specified.
OpcName(string, int)	Initializes a new instance of the OpcName class using the value and namespaceIndex specified.
OpcName(string, OpcNamespace)	Initializes a new instance of the OpcName class using the value and nameNamespace specified.

OpcName(string)

Initializes a new instance of the OpcName class using the value specified.

public OpcName(string value)

Public Sub New(value As String)

Parameters

Name	Type	Description
value	String	The string value of the name to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null name (see IsNull).

OpcName(string, int)

Initializes a new instance of the OpcName class using the value and namespaceIndex specified.

public OpcName(string value, int namespaceIndex)

Public Sub New(value As String, namespaceIndex As Integer)

Parameters

Name	Type	Description
value	String	The string value of the name to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null name (see IsNull).
namespaceIndex	Int32	The index of the namespace that this name should refer to.

OpcName(string, OpcNamespace)

Initializes a new instance of the OpcName class using the value and nameNamespace specified.

public OpcName(string value, OpcNamespace nameNamespace)

Public Sub New(value As String, nameNamespace As OpcNamespace)

Parameters

Name	Type	Description
value	String	The string value of the name to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null name (see IsNull).
nameNamespace	OpcNamespace	The namespace that this name should refer to.

Properties

IsNull

Gets a value indicating whether the name is a null name.

public bool IsNull { get; }

Public ReadOnly Property IsNull As Boolean

Property value

Boolean

The value true if the Value is a null reference (Nothing in Visual Basic) or equals to Empty; otherwise the value false.

Namespace

Gets the OpcNamespace used by the OpcName to describe the namespace to that the name belongs.

public OpcNamespace Namespace { get; }

Public ReadOnly Property [Namespace] As OpcNamespace

Property value

OpcNamespace

An instance of the OpcNamespace with the known information about the namespace to that the OpcName belongs.

NamespaceIndex

Gets the index of the namespace that this name belongs.

public int NamespaceIndex { get; }

Public ReadOnly Property NamespaceIndex As Integer

Property value

Int32

The index value which refers to the namespace in the namespace array of the server to that the name belong.

Remarks

The available namespaces of the server can be retrieved through reading the value of the namespaces-node using the node identifier 'OpcObjectTypes.Server.Namespaces'.

NamespaceUri

Gets the uniform resource identifier (URI) of the namespace referred by the NamespaceIndex.

public Uri NamespaceUri { get; }

Public ReadOnly Property NamespaceUri As Uri

Property value

Uri

The Uri to that the OpcName refers using the NamespaceIndex.

Null

static

Gets the default null name.

public static OpcName Null { get; }

Public Shared ReadOnly Property Null As OpcName

Property value

OpcName

An instance of the OpcName which can be used for general purpose in cases there a null name is enough.

Value

Gets the name without any namespace information.

public string Value { get; }

Public ReadOnly Property Value As String

Property value

String

The (unqualified) value of the name.

Methods

CompareTo

2 overloads

Overload	Description
CompareTo(object)	Compares the current OpcName with the other.
CompareTo(OpcName)	Compares the current OpcName with another OpcName.

CompareTo(object)

Compares the current OpcName with the other.

public int CompareTo(object other)

Public Function CompareTo(other As Object) As Integer

Parameters

Name	Type	Description
other	Object	The OpcName to compare with this OpcName.

Returns

Int32

A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(object)).

Implements

CompareTo(object)

CompareTo(OpcName)

Compares the current OpcName with another OpcName.

public int CompareTo(OpcName other)

Public Function CompareTo(other As OpcName) As Integer

Parameters

Name	Type	Description
other	OpcName	The OpcName to compare with this OpcName.

Returns

Int32

A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(T)).

Implements

CompareTo(OpcName)

Equals

2 overloads

Overload	Description
Equals(object)override	Determines whether the specified other is equal to this OpcName.
Equals(OpcName)	Determines whether the specified other is equal to this OpcName.

Equals(object)

override

Determines whether the specified other is equal to this OpcName.

public override bool Equals(object other)

Public Overrides Function Equals(other As Object) As Boolean

Parameters

Name	Type	Description
other	Object	The OpcName to compare to the current OpcName.

Returns

Boolean

The value true if the specified OpcName is equal to the current OpcName; otherwise the value false.

Overrides

Equals(object)

Equals(OpcName)

Determines whether the specified other is equal to this OpcName.

public bool Equals(OpcName other)

Public Function Equals(other As OpcName) As Boolean

Parameters

Name	Type	Description
other	OpcName	The OpcName to compare to the current OpcName.

Returns

Boolean

The value true if the specified OpcName is equal to the current OpcName; otherwise the value false.

Implements

Equals(OpcName)

GetHashCode

override

Retrieves a hash code for this OpcName.

public override int GetHashCode()

Public Overrides Function GetHashCode() As Integer

Returns

Int32

An int that contains the hash code for the OpcName.

Overrides

GetHashCode()

IsNullOrEmpty

static · since v2.14

Indicates whether the specified OpcName is null or its Value is null or an empty string ("").

public static bool IsNullOrEmpty(OpcName name)

Public Shared Function IsNullOrEmpty(name As OpcName) As Boolean

Parameters

Name	Type	Description
name	OpcName	The OpcName to test.

Returns

Boolean

The value true if the name parameter or its Value is null or an empty string (""); otherwise the value false.

Remarks

This method ignores the circumstance whether the Namespace of the name might be specified anyway.

Parse

static

Converts a name string to a OpcName instance.

public static OpcName Parse(string value)

Public Shared Function Parse(value As String) As OpcName

Parameters

Name	Type	Description
value	String	A string that contains a name.

Returns

OpcName

An instance of the OpcName class.

Exceptions

Exception	Condition
FormatException	The value is not a valid name.

ToString

override

Returns a string representing the name.

public override string ToString()

Public Overrides Function ToString() As String

Returns

String

A string formatted with the Value and Namespace of the name.

Overrides

ToString()

TryParse

static

Determines whether a string is a valid name.

public static bool TryParse(string value, out OpcName name)

Public Shared Function TryParse(value As String, name As OpcName) As Boolean

Parameters

Name	Type	Description
value	String	The string to validate.
name	out OpcName	The OpcName version of the string.

Returns

Boolean

The value true, if value is a valid name; otherwise the value false.

Operators

Equality

static

Returns a value indicating whether two instance of OpcName are equal.

public static bool operator ==(OpcName left, OpcName right)

Public Shared Operator =(left As OpcName, right As OpcName) As Boolean

Parameters

Name	Type	Description
left	OpcName	The first OpcName to compare.
right	OpcName	The second OpcName to compare.

Returns

Boolean

The value true if left and right are equal; otherwise the value false.

Explicit

static

Converts a OpcName to an QualifiedName object.

[CLSCompliant(false)]
public static explicit operator QualifiedName(OpcName value)

<CLSCompliant(False)>
Public Shared Narrowing Operator CType(value As OpcName) As QualifiedName

Parameters

Name	Type	Description
value	OpcName	A OpcName that represents the qualified name.

Returns

QualifiedName

An instance of the QualifiedName class initialized from the value.

GreaterThan

static

Determines whether the first specified OpcName object is greater than the second specified OpcName object.

public static bool operator >(OpcName left, OpcName right)

Public Shared Operator >(left As OpcName, right As OpcName) As Boolean

Parameters

Name	Type	Description
left	OpcName	The first OpcName object.
right	OpcName	The second OpcName object.

Returns

Boolean

The value true if left is greater than right; otherwise, false.

GreaterThanOrEqual

static

Determines whether the first specified OpcName object is greater than or equal to the second specified OpcName object.

public static bool operator >=(OpcName left, OpcName right)

Public Shared Operator >=(left As OpcName, right As OpcName) As Boolean

Parameters

Name	Type	Description
left	OpcName	The first OpcName object.
right	OpcName	The second OpcName object.

Returns

Boolean

The value true if left is greater than or equal to right; otherwise, false.

Implicit

static · 2 overloads

Overload	Description
implicit operator OpcName(string)static	Converts a string to an OpcName object.
implicit operator OpcName(QualifiedName)static	Converts a QualifiedName to an OpcName object.

implicit operator OpcName(string)

static

Converts a string to an OpcName object.

public static implicit operator OpcName(string value)

Public Shared Widening Operator CType(value As String) As OpcName

Parameters

Name	Type	Description
value	String	A string that represents the name.

Returns

OpcName

An instance of the OpcName class initialized from the value.

implicit operator OpcName(QualifiedName)

static

Converts a QualifiedName to an OpcName object.

[CLSCompliant(false)]
public static implicit operator OpcName(QualifiedName value)

<CLSCompliant(False)>
Public Shared Widening Operator CType(value As QualifiedName) As OpcName

Parameters

Name	Type	Description
value	QualifiedName	A QualifiedName that represents the name.

Returns

OpcName

An instance of the OpcName class initialized from the value.

Inequality

static

Returns a value indicating whether two instances of OpcName are not equal.

public static bool operator !=(OpcName left, OpcName right)

Public Shared Operator <>(left As OpcName, right As OpcName) As Boolean

Parameters

Name	Type	Description
left	OpcName	The first OpcName to compare.
right	OpcName	The second OpcName to compare.

Returns

Boolean

The value true if left and right are not equal; otherwise the value false.

LessThan

static

Determines whether the first specified OpcName object is less than the second specified OpcName object.

public static bool operator <(OpcName left, OpcName right)

Public Shared Operator <(left As OpcName, right As OpcName) As Boolean

Parameters

Name	Type	Description
left	OpcName	The first OpcName object.
right	OpcName	The second OpcName object.

Returns

Boolean

The value true if left is less than right; otherwise the value false.

Exceptions

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

LessThanOrEqual

static

Determines whether the first specified OpcName object is less than or equal to the second OpcName object.

public static bool operator <=(OpcName left, OpcName right)

Public Shared Operator <=(left As OpcName, right As OpcName) As Boolean

Parameters

Name	Type	Description
left	OpcName	The first OpcName object.
right	OpcName	The second OpcName object.

Returns

Boolean

The value true if left is less than or equal to right; otherwise the value false.

Exceptions

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