Reference

OpcFilterOperand Members

Type

OpcFilterOperand

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcFilterOperand

protected

Initializes a new instance of the OpcFilterOperand class using the content specified.

protected OpcFilterOperand(FilterOperand content)

Protected Sub New(content As FilterOperand)

Parameters

Name	Type	Description
content	FilterOperand	The FilterOperand to wrap, maintain and represented.

Exceptions

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

Methods

Between

2 overloads

Overload	Description
Between(object, object)	Creates an element which determines whether this operand is greater than or equal to the lower value and less than or equal to the upper value.
Between(OpcFilterOperand, OpcFilterOperand)	Creates an element which determines whether this operand is greater than or equal to the lower operand and less than or equal to the upper operand.

Between(object, object)

Creates an element which determines whether this operand is greater than or equal to the lower value and less than or equal to the upper value.

public OpcContentFilterElement Between(object lower, object upper)

Public Function Between(
    lower As Object,
    upper As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
lower	Object	The lower bound, which is used as an OpcLiteralOperand.
upper	Object	The upper bound, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator Between whose operands are this operand and both bounds.

Between(OpcFilterOperand, OpcFilterOperand)

Creates an element which determines whether this operand is greater than or equal to the lower operand and less than or equal to the upper operand.

public OpcContentFilterElement Between(
    OpcFilterOperand lower,
    OpcFilterOperand upper)

Public Function Between(
    lower As OpcFilterOperand,
    upper As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
lower	OpcFilterOperand	The operand of the lower bound.
upper	OpcFilterOperand	The operand of the upper bound.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator Between whose operands are this operand and both bounds.

Exceptions

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

Cast

2 overloads

Overload	Description
Cast(object)	Creates an element which converts this operand to the data type identified by the right value.
Cast(OpcFilterOperand)	Creates an element which converts this operand to the data type identified by the right operand.

Cast(object)

Creates an element which converts this operand to the data type identified by the right value.

public OpcContentFilterElement Cast(object right)

Public Function Cast(right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
right	Object	The value identifying the data type, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator Cast.

Cast(OpcFilterOperand)

Creates an element which converts this operand to the data type identified by the right operand.

public OpcContentFilterElement Cast(OpcFilterOperand right)

Public Function Cast(right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
right	OpcFilterOperand	The operand identifying the data type.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator Cast.

Exceptions

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

Equals

2 overloads

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

Equals(object)

override

Determines whether the specified other is equal to this OpcFilterOperand.

public override bool Equals(object other)

Public Overrides Function Equals(other As Object) As Boolean

Parameters

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

Returns

Boolean

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

Overrides

Equals(object)

Equals(OpcFilterOperand)

Determines whether the specified other is equal to this OpcFilterOperand.

public bool Equals(OpcFilterOperand other)

Public Function Equals(other As OpcFilterOperand) As Boolean

Parameters

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

Returns

Boolean

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

EqualsTo

2 overloads

Overload	Description
EqualsTo(object)	Creates an element which determines whether this operand is equal to the right value.
EqualsTo(OpcFilterOperand)	Creates an element which determines whether this operand is equal to the right operand.

EqualsTo(object)

Creates an element which determines whether this operand is equal to the right value.

public OpcContentFilterElement EqualsTo(object right)

Public Function EqualsTo(right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
right	Object	The value to compare with, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator EqualsTo.

EqualsTo(OpcFilterOperand)

Creates an element which determines whether this operand is equal to the right operand.

public OpcContentFilterElement EqualsTo(OpcFilterOperand right)

Public Function EqualsTo(right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator EqualsTo.

Exceptions

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

GetHashCode

override

Retrieves a hash code for this OpcFilterOperand.

public override int GetHashCode()

Public Overrides Function GetHashCode() As Integer

Returns

Int32

An int that contains the hash code for the OpcFilterOperand.

Overrides

GetHashCode()

GreaterThan

2 overloads

Overload	Description
GreaterThan(object)	Creates an element which determines whether this operand is greater than the right value.
GreaterThan(OpcFilterOperand)	Creates an element which determines whether this operand is greater than the right operand.

GreaterThan(object)

Creates an element which determines whether this operand is greater than the right value.

public OpcContentFilterElement GreaterThan(object right)

Public Function GreaterThan(right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
right	Object	The value to compare with, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator GreaterThan.

GreaterThan(OpcFilterOperand)

Creates an element which determines whether this operand is greater than the right operand.

public OpcContentFilterElement GreaterThan(OpcFilterOperand right)

Public Function GreaterThan(
    right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator GreaterThan.

Exceptions

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

GreaterThanOrEqualsTo

2 overloads

Overload	Description
GreaterThanOrEqualsTo(object)	Creates an element which determines whether this operand is greater than or equal to the right value.
GreaterThanOrEqualsTo(OpcFilterOperand)	Creates an element which determines whether this operand is greater than or equal to the right operand.

GreaterThanOrEqualsTo(object)

Creates an element which determines whether this operand is greater than or equal to the right value.

public OpcContentFilterElement GreaterThanOrEqualsTo(object right)

Public Function GreaterThanOrEqualsTo(
    right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
right	Object	The value to compare with, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator GreaterThanOrEqualsTo.

GreaterThanOrEqualsTo(OpcFilterOperand)

Creates an element which determines whether this operand is greater than or equal to the right operand.

public OpcContentFilterElement GreaterThanOrEqualsTo(OpcFilterOperand right)

Public Function GreaterThanOrEqualsTo(
    right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator GreaterThanOrEqualsTo.

Exceptions

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

InList

Creates an element which determines whether this operand is equal to the item or one of the items specified.

public OpcContentFilterElement InList(
    OpcFilterOperand item,
    params OpcFilterOperand[] items)

Public Function InList(
    item As OpcFilterOperand,
    ParamArray items As OpcFilterOperand()) As OpcContentFilterElement

Parameters

Name	Type	Description
item	OpcFilterOperand	The first operand to compare with.
items	params OpcFilterOperand[]	The further operands to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator InList.

Exceptions

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

InView

Creates an element which determines whether the node the filter is applied to is contained in the view identified by this operand.

public OpcContentFilterElement InView()

Public Function InView() As OpcContentFilterElement

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator InView.

IsNull

Creates an element which determines whether this operand is a null value.

public OpcContentFilterElement IsNull()

Public Function IsNull() As OpcContentFilterElement

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator IsNull.

LessThan

2 overloads

Overload	Description
LessThan(object)	Creates an element which determines whether this operand is less than the right value.
LessThan(OpcFilterOperand)	Creates an element which determines whether this operand is less than the right operand.

LessThan(object)

Creates an element which determines whether this operand is less than the right value.

public OpcContentFilterElement LessThan(object right)

Public Function LessThan(right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
right	Object	The value to compare with, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator LessThan.

LessThan(OpcFilterOperand)

Creates an element which determines whether this operand is less than the right operand.

public OpcContentFilterElement LessThan(OpcFilterOperand right)

Public Function LessThan(right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator LessThan.

Exceptions

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

LessThanOrEqualsTo

2 overloads

Overload	Description
LessThanOrEqualsTo(object)	Creates an element which determines whether this operand is less than or equal to the right value.
LessThanOrEqualsTo(OpcFilterOperand)	Creates an element which determines whether this operand is less than or equal to the right operand.

LessThanOrEqualsTo(object)

Creates an element which determines whether this operand is less than or equal to the right value.

public OpcContentFilterElement LessThanOrEqualsTo(object right)

Public Function LessThanOrEqualsTo(right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
right	Object	The value to compare with, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator LessThanOrEqualsTo.

LessThanOrEqualsTo(OpcFilterOperand)

Creates an element which determines whether this operand is less than or equal to the right operand.

public OpcContentFilterElement LessThanOrEqualsTo(OpcFilterOperand right)

Public Function LessThanOrEqualsTo(
    right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator LessThanOrEqualsTo.

Exceptions

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

Like

2 overloads

Overload	Description
Like(object)	Creates an element which determines whether this operand matches the pattern of the right value.
Like(OpcFilterOperand)	Creates an element which determines whether this operand matches the pattern of the right operand.

Like(object)

Creates an element which determines whether this operand matches the pattern of the right value.

public OpcContentFilterElement Like(object right)

Public Function [Like](right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
right	Object	The value providing the pattern, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator Like.

Like(OpcFilterOperand)

Creates an element which determines whether this operand matches the pattern of the right operand.

public OpcContentFilterElement Like(OpcFilterOperand right)

Public Function [Like](right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
right	OpcFilterOperand	The operand providing the pattern.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator Like.

Exceptions

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

Not

Creates an element which determines whether this operand, a Boolean value, is false.

public OpcContentFilterElement Not()

Public Function [Not]() As OpcContentFilterElement

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator Not.

OfType

2 overloads

Overload	Description
OfType(OpcNodeId)static · since v2.19	Creates an element which determines whether the node the filter is applied to is of the type identified by the typeId specified.
OfType()	Creates an element which determines whether the node the filter is applied to is of the type identified by this operand.

OfType(OpcNodeId)

static · since v2.19

Creates an element which determines whether the node the filter is applied to is of the type identified by the typeId specified.

public static OpcContentFilterElement OfType(OpcNodeId typeId)

Public Shared Function OfType(typeId As OpcNodeId) As OpcContentFilterElement

Parameters

Name	Type	Description
typeId	OpcNodeId	The identifier of the type.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator OfType.

OfType()

Creates an element which determines whether the node the filter is applied to is of the type identified by this operand.

public OpcContentFilterElement OfType()

Public Function OfType() As OpcContentFilterElement

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator OfType.

ToString

override

Returns a string that represents the operand.

public override string ToString()

Public Overrides Function ToString() As String

Returns

String

The string representation of the operand provided by the OPC UA stack.

Overrides

ToString()

Operators

Equality

static · 2 overloads

Overload	Description
operator ==(OpcFilterOperand, object)static	Creates an element which determines whether the left operand is equal to the right value.
operator ==(OpcFilterOperand, OpcFilterOperand)static	Creates an element which determines whether the left operand is equal to the right operand.

Exceptions (all overloads)

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

operator ==(OpcFilterOperand, object)

static

Creates an element which determines whether the left operand is equal to the right value.

public static OpcContentFilterElement operator ==(
    OpcFilterOperand left,
    object right)

Public Shared Operator =(
    left As OpcFilterOperand,
    right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	Object	The value to compare with, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator EqualsTo.

Remarks

The operator does not compare the operands; use Equals to compare them.

operator ==(OpcFilterOperand, OpcFilterOperand)

static

Creates an element which determines whether the left operand is equal to the right operand.

public static OpcContentFilterElement operator ==(
    OpcFilterOperand left,
    OpcFilterOperand right)

Public Shared Operator =(
    left As OpcFilterOperand,
    right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator EqualsTo.

Remarks

The operator does not compare the operands; use Equals to compare them.

GreaterThan

static · 2 overloads

Overload	Description
operator >(OpcFilterOperand, object)static	Creates an element which determines whether the left operand is greater than the right value.
operator >(OpcFilterOperand, OpcFilterOperand)static	Creates an element which determines whether the left operand is greater than the right operand.

operator >(OpcFilterOperand, object)

static

Creates an element which determines whether the left operand is greater than the right value.

public static OpcContentFilterElement operator >(
    OpcFilterOperand left,
    object right)

Public Shared Operator >(
    left As OpcFilterOperand,
    right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	Object	The value to compare with, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator GreaterThan.

Exceptions

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

operator >(OpcFilterOperand, OpcFilterOperand)

static

Creates an element which determines whether the left operand is greater than the right operand.

public static OpcContentFilterElement operator >(
    OpcFilterOperand left,
    OpcFilterOperand right)

Public Shared Operator >(
    left As OpcFilterOperand,
    right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator GreaterThan.

Exceptions

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

GreaterThanOrEqual

static · 2 overloads

Overload	Description
operator >=(OpcFilterOperand, object)static	Creates an element which determines whether the left operand is greater than or equal to the right value.
operator >=(OpcFilterOperand, OpcFilterOperand)static	Creates an element which determines whether the left operand is greater than or equal to the right operand.

operator >=(OpcFilterOperand, object)

static

Creates an element which determines whether the left operand is greater than or equal to the right value.

public static OpcContentFilterElement operator >=(
    OpcFilterOperand left,
    object right)

Public Shared Operator >=(
    left As OpcFilterOperand,
    right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	Object	The value to compare with, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator GreaterThanOrEqualsTo.

Exceptions

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

operator >=(OpcFilterOperand, OpcFilterOperand)

static

Creates an element which determines whether the left operand is greater than or equal to the right operand.

public static OpcContentFilterElement operator >=(
    OpcFilterOperand left,
    OpcFilterOperand right)

Public Shared Operator >=(
    left As OpcFilterOperand,
    right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator GreaterThanOrEqualsTo.

Exceptions

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

Inequality

static · 2 overloads

Overload	Description
operator !=(OpcFilterOperand, object)static	Not supported.
operator !=(OpcFilterOperand, OpcFilterOperand)static	Not supported.

Exceptions (all overloads)

Exception	Condition
NotSupportedException	Always, because the operator is not supported. An element which determines whether the operands differ can be built from the operators < and > combined using the operator |.

operator !=(OpcFilterOperand, object)

static

Not supported.

public static OpcContentFilterElement operator !=(
    OpcFilterOperand left,
    object right)

Public Shared Operator <>(
    left As OpcFilterOperand,
    right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	Object	The value to compare with.

Returns

OpcContentFilterElement

No value, because the operator always throws an exception.

operator !=(OpcFilterOperand, OpcFilterOperand)

static

Not supported.

public static OpcContentFilterElement operator !=(
    OpcFilterOperand left,
    OpcFilterOperand right)

Public Shared Operator <>(
    left As OpcFilterOperand,
    right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

No value, because the operator always throws an exception.

LessThan

static · 2 overloads

Overload	Description
operator <(OpcFilterOperand, object)static	Creates an element which determines whether the left operand is less than the right value.
operator <(OpcFilterOperand, OpcFilterOperand)static	Creates an element which determines whether the left operand is less than the right operand.

operator <(OpcFilterOperand, object)

static

Creates an element which determines whether the left operand is less than the right value.

public static OpcContentFilterElement operator <(
    OpcFilterOperand left,
    object right)

Public Shared Operator <(
    left As OpcFilterOperand,
    right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	Object	The value to compare with, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator LessThan.

Exceptions

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

operator <(OpcFilterOperand, OpcFilterOperand)

static

Creates an element which determines whether the left operand is less than the right operand.

public static OpcContentFilterElement operator <(
    OpcFilterOperand left,
    OpcFilterOperand right)

Public Shared Operator <(
    left As OpcFilterOperand,
    right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator LessThan.

Exceptions

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

LessThanOrEqual

static · 2 overloads

Overload	Description
operator <=(OpcFilterOperand, object)static	Creates an element which determines whether the left operand is less than or equal to the right value.
operator <=(OpcFilterOperand, OpcFilterOperand)static	Creates an element which determines whether the left operand is less than or equal to the right operand.

operator <=(OpcFilterOperand, object)

static

Creates an element which determines whether the left operand is less than or equal to the right value.

public static OpcContentFilterElement operator <=(
    OpcFilterOperand left,
    object right)

Public Shared Operator <=(
    left As OpcFilterOperand,
    right As Object) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	Object	The value to compare with, which is used as an OpcLiteralOperand.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator LessThanOrEqualsTo.

Exceptions

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

operator <=(OpcFilterOperand, OpcFilterOperand)

static

Creates an element which determines whether the left operand is less than or equal to the right operand.

public static OpcContentFilterElement operator <=(
    OpcFilterOperand left,
    OpcFilterOperand right)

Public Shared Operator <=(
    left As OpcFilterOperand,
    right As OpcFilterOperand) As OpcContentFilterElement

Parameters

Name	Type	Description
left	OpcFilterOperand	The operand to compare.
right	OpcFilterOperand	The operand to compare with.

Returns

OpcContentFilterElement

An OpcContentFilterElement using the operator LessThanOrEqualsTo.

Exceptions

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