Reference

OpcStatus Members

Type

OpcStatus

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcStatus

2 overloads

Overload	Description
OpcStatus()	Initializes a new instance of the OpcStatus class which represents a 'neutral good' status.
OpcStatus(OpcStatusCode)	Initializes a new instance of the OpcStatus class which represents the information associated with the code specified.

OpcStatus()

Initializes a new instance of the OpcStatus class which represents a 'neutral good' status.

public OpcStatus()

Public Sub New()

OpcStatus(OpcStatusCode)

Initializes a new instance of the OpcStatus class which represents the information associated with the code specified.

[CLSCompliant(false)]
public OpcStatus(OpcStatusCode code)

<CLSCompliant(False)>
Public Sub New(code As OpcStatusCode)

Parameters

Name	Type	Description
code	OpcStatusCode	The OpcStatusCode the information associated with the value is to be represented.

Properties

AggregateBits

Gets a value indicating where aggregated data comes from.

public OpcStatusAggregateBits AggregateBits { get; }

Public ReadOnly Property AggregateBits As OpcStatusAggregateBits

Property value

OpcStatusAggregateBits

A combination of the members defined by the OpcStatusAggregateBits enumeration.

Code

Gets the underlying status code its information is represented by the OpcStatus.

[CLSCompliant(false)]
public OpcStatusCode Code { get; }

<CLSCompliant(False)>
Public ReadOnly Property Code As OpcStatusCode

Property value

OpcStatusCode

One of the members defined by the OpcStatusCode enumeration.

CodeBits

Gets the bits (16:31) of the Code used to provide status data without any extra information.

[CLSCompliant(false)]
public uint CodeBits { get; }

<CLSCompliant(False)>
Public ReadOnly Property CodeBits As UInteger

Property value

UInt32

The 16 bits used to provide status data without any extra information.

Description

Gets a value which describes the status in detail.

public string Description { get; }

Public ReadOnly Property Description As String

Property value

String

A string which describes the OpcStatusCode represented in detail.

FlagBits

Gets the bits (0:15) of the Code used to provide additional information about the status.

[CLSCompliant(false)]
public uint FlagBits { get; }

<CLSCompliant(False)>
Public ReadOnly Property FlagBits As UInteger

Property value

UInt32

The 16 bits used to provide additional information about the status.

HasSemanticsChanged

Gets a value indicating that the semantics of the associated data value have changed. Clients should not process the data value until they re-read the metadata associated with the variable. Servers should set this property to true if the metadata has changed in way that could cause application errors if the Client does not re-read the metadata. This is for example a change to the engineering units.

public bool HasSemanticsChanged { get; }

Public ReadOnly Property HasSemanticsChanged As Boolean

Property value

Boolean

The value true if the semantic information of a value have changed and a Client needs to re-read the metadata before processing the data value; otherwise the value false.

Remarks

Other specifications may define additional conditions. A Server may define other conditions that cause this property to be equals true. This property is only used as part of data change notifications or historical read operations. In other contexts this property shall be equals false.

HasStructureChanged

Gets a value indicating that the structure of the associated data value has changed since the last notification. Clients should not process the data value unless they re-read the metadata. Servers shall set this property to true if the data type encoding used for a variable or the enumeration information (via EnumStrings) of the data type of a variable changes.

public bool HasStructureChanged { get; }

Public ReadOnly Property HasStructureChanged As Boolean

Property value

Boolean

The value true if the Server wants to warn Clients, that parse complex data values, that their parsing routines could fail because the serialized form of the data value changed; otherwise the value false.

Remarks

This property is only used as part of data change notifications or historical read operations. In other contexts this property shall be equals false.

HasValueInfo

Gets a value indicating that the status information is associated with a data value returned from the Server.

public bool HasValueInfo { get; }

Public ReadOnly Property HasValueInfo As Boolean

Property value

Boolean

The value true if the status information belongs to a data value returned from the Server; otherwise the value false.

IsBad

Gets a value indicating whether the status Code expresses a bad outcome of the operation associated with this OpcStatus. In the most cases a Client has performed an invalid or (at the moment) unsupported operation. Another reason for a bad status could be that the Server may fail to complete the requested operation upon internal issues with the underlying data source. For more details about specific bad status information see the "bad" members of the OpcStatusCode enumeration.

public bool IsBad { get; }

Public ReadOnly Property IsBad As Boolean

Property value

Boolean

The value true if the Code expresses a failure; otherwise the value false.

IsGood

Gets a value indicating whether the status Code expresses a good outcome of the operation associated with this OpcStatus. The Client can be sure about that the Server successfully completed the operation requested and its result is totally reliable. Specific "good" status codes may inform the Client about the circumstances under which the operation completed. For more details about specific good status information see the "good" members of the OpcStatusCode enumeration.

public bool IsGood { get; }

Public ReadOnly Property IsGood As Boolean

Property value

Boolean

The value true if the Code expresses a good outcome; otherwise the value false.

IsOverflow

Gets a value indicating that not every detected change has been returned since the Servers queue buffer of a monitored item reached its limit and had to purge out data.

public bool IsOverflow { get; }

Public ReadOnly Property IsOverflow As Boolean

Property value

Boolean

The value true if the queue buffer of a monitored item reached its limit and had to purge out data.

Remarks

This property is only equals true if the monitored item queue size is greater than one.

IsUncertain

Gets a value indicating whether the status Code expresses an uncertain outcome of the operation associated with this OpcStatus. An operation with an uncertain outcome expresses in general that the Server can not guarantee a total reliable data value nor an entire complete and successful processing of an operation. The reasons to uncertains varying, for more details about specific uncertain status information see the "uncertain" members of the OpcStatusCode enumeration.

public bool IsUncertain { get; }

Public ReadOnly Property IsUncertain As Boolean

Property value

Boolean

The value true if the Code expresses an uncertain and there not reliable outcome; otherwise the value false.

LimitBits

Gets a value indicating the constraints a value falls within.

public OpcStatusLimitBits LimitBits { get; }

Public ReadOnly Property LimitBits As OpcStatusLimitBits

Property value

OpcStatusLimitBits

A combination of the members defined by the OpcStatusLimitBits enumeration.

SubCode

Gets the code used to represent different conditions.

[CLSCompliant(false)]
public uint SubCode { get; }

<CLSCompliant(False)>
Public ReadOnly Property SubCode As UInteger

Property value

UInt32

A value representing the condition under that the status was produced.

Methods

CompareTo

2 overloads

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

CompareTo(object)

Compares the current OpcStatus with the other.

public int CompareTo(object other)

Public Function CompareTo(other As Object) As Integer

Parameters

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

Returns

Int32

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

Implements

CompareTo(object)

CompareTo(OpcStatus)

Compares the current OpcStatus with another OpcStatus.

public int CompareTo(OpcStatus other)

Public Function CompareTo(other As OpcStatus) As Integer

Parameters

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

Returns

Int32

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

Implements

CompareTo(OpcStatus)

Equals

2 overloads

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

Equals(object)

override

Determines whether the specified other is equal to this OpcStatus.

public override bool Equals(object other)

Public Overrides Function Equals(other As Object) As Boolean

Parameters

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

Returns

Boolean

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

Overrides

Equals(object)

Equals(OpcStatus)

Determines whether the specified other is equal to this OpcStatus.

public bool Equals(OpcStatus other)

Public Function Equals(other As OpcStatus) As Boolean

Parameters

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

Returns

Boolean

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

Implements

Equals(OpcStatus)

GetHashCode

override

Retrieves a hash code for this OpcStatus.

public override int GetHashCode()

Public Overrides Function GetHashCode() As Integer

Returns

Int32

An int that contains the hash code for the OpcStatus.

Overrides

GetHashCode()

OnChanged

protected · virtual

Raises the Changed event of the OpcStatus.

protected virtual void OnChanged(EventArgs e)

Protected Overridable Sub OnChanged(e As EventArgs)

Parameters

Name	Type	Description
e	EventArgs	The event data.

ToString

override

Returns a string that represents the current OpcStatus.

public override string ToString()

Public Overrides Function ToString() As String

Returns

String

A string that represents the current OpcStatus including the Code and Description of the status represented.

Overrides

ToString()

Update

2 overloads

Overload	Description
Update(OpcStatusCode)	Updates the Code represented by the OpcStatus using the code specified.
Update(OpcStatus)since v2.8	Updates the OpcStatus using the status data of the otherOpcStatus.

Update(OpcStatusCode)

Updates the Code represented by the OpcStatus using the code specified.

[CLSCompliant(false)]
public void Update(OpcStatusCode code)

<CLSCompliant(False)>
Public Sub Update(code As OpcStatusCode)

Parameters

Name	Type	Description
code	OpcStatusCode	The OpcStatusCode to represent.

Remarks

Updating the OpcStatus results into Changed events.

Update(OpcStatus)

since v2.8

Updates the OpcStatus using the status data of the otherOpcStatus.

public void Update(OpcStatus other)

Public Sub Update(other As OpcStatus)

Parameters

Name	Type	Description
other	OpcStatus	The other OpcStatus its status information is to be adopted.

Remarks

Updating the OpcStatus results into Changed events.

Events

Changed

Occurs when the OpcStatus changes.

public event EventHandler Changed

Public Event Changed As EventHandler

Event type

EventHandler

Operators

Equality

static

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

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

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

Parameters

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

Returns

Boolean

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

GreaterThan

static

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

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

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

Parameters

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

Returns

Boolean

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

GreaterThanOrEqual

static

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

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

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

Parameters

Name	Type	Description
left	OpcStatus	The first OpcStatus object.
right	OpcStatus	The second OpcStatus 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 OpcStatus(OpcStatusCode)static	Converts a OpcStatusCode to an OpcStatus object.
implicit operator OpcStatus(StatusCode)static	Converts a StatusCode to an OpcStatus object.

implicit operator OpcStatus(OpcStatusCode)

static

Converts a OpcStatusCode to an OpcStatus object.

[CLSCompliant(false)]
public static implicit operator OpcStatus(OpcStatusCode value)

<CLSCompliant(False)>
Public Shared Widening Operator CType(value As OpcStatusCode) As OpcStatus

Parameters

Name	Type	Description
value	OpcStatusCode	A OpcStatusCode that represents the status.

Returns

OpcStatus

An instance of the OpcStatus class initialized from the value.

implicit operator OpcStatus(StatusCode)

static

Converts a StatusCode to an OpcStatus object.

[CLSCompliant(false)]
public static implicit operator OpcStatus(StatusCode value)

<CLSCompliant(False)>
Public Shared Widening Operator CType(value As StatusCode) As OpcStatus

Parameters

Name	Type	Description
value	StatusCode	A StatusCode that represents the status.

Returns

OpcStatus

An instance of the OpcStatus class initialized from the value.

Inequality

static

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

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

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

Parameters

Name	Type	Description
left	OpcStatus	The first OpcStatus to compare.
right	OpcStatus	The second OpcStatus 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 OpcStatus object is less than the second specified OpcStatus object.

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

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

Parameters

Name	Type	Description
left	OpcStatus	The first OpcStatus object.
right	OpcStatus	The second OpcStatus 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 OpcStatus object is less than or equal to the second OpcStatus object.

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

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

Parameters

Name	Type	Description
left	OpcStatus	The first OpcStatus object.
right	OpcStatus	The second OpcStatus 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).