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

 Manage book (0 page(s))
 Help

OpcResult Members

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

Constructors

OpcResult(Exception)

Initializes a new instance of the OpcResult class using the exception specified.

C# 

public OpcResult(Exception exception)


Parameters

exception Exception

The Exception from that the result information is to be determined.


Remarks

An OpcResult constructed from an Exception does always define the Bad as Code. Only in case there Exception does define a OpcException the Code may depend on the contents of the exception.

OpcResult(Exception, String)

Initializes a new instance of the OpcResult class using the exception and description specified.

C# 

public OpcResult(Exception exception, string description)


Parameters

exception Exception

The Exception from that the result information is to be determined.

description String

The String which describes the meaning of the exception represented by the result.

OpcResult(OpcStatusCode)

Initializes a new instance of the OpcResult class using the statusCode specified.

C# 

[CLSCompliant(false)]
public OpcResult(OpcStatusCode statusCode)


Parameters

statusCode OpcStatusCode

One of the OpcStatusCode enumeration members identifying the result to represent.

OpcResult(OpcStatusCode, String)

Initializes a new instance of the OpcResult class using the statusCode and description specified.

C# 

[CLSCompliant(false)]
public OpcResult(OpcStatusCode statusCode, string description)


Parameters

statusCode OpcStatusCode

One of the OpcStatusCode enumeration members identifying the result to represent.

description String

The String which describes the meaning of the statusCode represented by the result.

Properties

Addition

Gets additional diagnostic/debugging information associated with the operation which provides the result represented.

C# 

public virtual string Addition { get; }


Property Value

String

A string representing additional diagnostic/debugging information.

Code

Gets the OpcStatusCode associated with the result.

C# 

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


Property Value

OpcStatusCode

One of the members defined by the OpcStatusCode enumeration or a custom numeric expression for custom status codes.

Description

Gets the localized description of the result represented.

C# 

public virtual OpcText Description { get; }


Property Value

OpcText

The localized description from that the result has been created if neither a null reference (Nothing in Visual Basic) nor empty; otherwise the description associated with the Code.

InnerResult

Gets the OpcResult instance that caused the current result.

C# 

public OpcResult InnerResult { get; }


Property Value

OpcResult

An object that describes the result that caused the current result. This value can be a null reference (Nothing in Visual Basic).

IsBad

Gets a value indicating whether the result falls within the category bad.

C# 

public virtual bool IsBad { get; }


Property Value

Boolean

The value true if the result falls within the category bad; otherwise the value false.

IsGood

Gets a value indicating whether the result falls within the category good.

C# 

public virtual bool IsGood { get; }


Property Value

Boolean

The value true if the result falls within the category good; otherwise the value false.

IsUncertain

Gets a value indicating whether the result falls within the category uncertain.

C# 

public virtual bool IsUncertain { get; }


Property Value

Boolean

The value true if the result falls within the category uncertain; otherwise the value false.

Methods

CompareTo(Object)

Compares the current OpcResult with the other.

C# 

public int CompareTo(object other)


Parameters

other Object

The OpcResult to compare with this OpcResult.


Returns

Int32

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

CompareTo(OpcResult)

Compares the current OpcResult with another OpcResult.

C# 

public int CompareTo(OpcResult other)


Parameters

other OpcResult

The OpcResult to compare with this OpcResult.


Returns

Int32

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

Equals(Object)

Determines whether the specified other is equal to this OpcResult.

C# 

public override bool Equals(object other)


Parameters

other Object

The OpcResult to compare to the current OpcResult.


Returns

Boolean

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

Equals(OpcResult)

Determines whether the specified other is equal to this OpcResult.

C# 

public bool Equals(OpcResult other)


Parameters

other OpcResult

The OpcResult to compare to the current OpcResult.


Returns

Boolean

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

GetBaseResult()

Returns the OpcResult that is the root cause of one or more subsequent exceptions.

C# 

public OpcResult GetBaseResult()


Returns

OpcResult

The first result captured in a chain of results. If the InnerResult property of the current result is a null reference (Nothing in Visual Basic), this method returns the current result.

GetHashCode()

Retrieves a hash code for this OpcResult.

C# 

public override int GetHashCode()


Returns

Int32

An Int32 that contains the hash code for the OpcResult.

ToString()

Returns a string that represents the current OpcResult.

C# 

public override string ToString()


Returns

String

A string that represents the current OpcResult including the Code and Description of the result represented.

Operators

Equality(OpcResult, OpcResult)

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

C# 

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

Explicit(OpcResult to ServiceResult)

Converts a OpcResult to an ServiceResult object.

C# 

[CLSCompliant(false)]
public static explicit operator ServiceResult(OpcResult value)

GreaterThan(OpcResult, OpcResult)

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

C# 

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

GreaterThanOrEqual(OpcResult, OpcResult)

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

C# 

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

Implicit(Boolean to OpcResult)

Converts a Boolean to an OpcResult object.

C# 

public static implicit operator OpcResult(bool value)

Implicit(Byte to OpcResult)

Converts a Byte to an OpcResult object.

C# 

public static implicit operator OpcResult(byte value)

Implicit(Decimal to OpcResult)

Converts a Decimal to an OpcResult object.

C# 

public static implicit operator OpcResult(decimal value)

Implicit(Double to OpcResult)

Converts a Double to an OpcResult object.

C# 

public static implicit operator OpcResult(double value)

Implicit(Int16 to OpcResult)

Converts a Int16 to an OpcResult object.

C# 

public static implicit operator OpcResult(short value)

Implicit(Int32 to OpcResult)

Converts a Int32 to an OpcResult object.

C# 

public static implicit operator OpcResult(int value)

Implicit(Int64 to OpcResult)

Converts a Int64 to an OpcResult object.

C# 

public static implicit operator OpcResult(long value)

Implicit(Nullable<Boolean> to OpcResult)

Converts a nullable Boolean to an OpcResult object.

C# 

public static implicit operator OpcResult(bool? value)

Implicit(Nullable<Byte> to OpcResult)

Converts a nullable Byte to an OpcResult object.

C# 

public static implicit operator OpcResult(byte? value)

Implicit(Nullable<Decimal> to OpcResult)

Converts a nullable Decimal to an OpcResult object.

C# 

public static implicit operator OpcResult(decimal? value)

Implicit(Nullable<Double> to OpcResult)

Converts a nullable Double to an OpcResult object.

C# 

public static implicit operator OpcResult(double? value)

Implicit(Nullable<Int16> to OpcResult)

Converts a nullable Int16 to an OpcResult object.

C# 

public static implicit operator OpcResult(short? value)

Implicit(Nullable<Int32> to OpcResult)

Converts a nullable Int32 to an OpcResult object.

C# 

public static implicit operator OpcResult(int? value)

Implicit(Nullable<Int64> to OpcResult)

Converts a nullable Int64 to an OpcResult object.

C# 

[CLSCompliant(false)]
public static implicit operator OpcResult(long? value)

Implicit(Nullable<SByte> to OpcResult)

Converts a nullable SByte to an OpcResult object.

C# 

[CLSCompliant(false)]
public static implicit operator OpcResult(sbyte? value)

Implicit(Nullable<Single> to OpcResult)

Converts a nullable Single to an OpcResult object.

C# 

public static implicit operator OpcResult(float? value)

Implicit(Nullable<UInt32> to OpcResult)

Converts a nullable UInt32 to an OpcResult object.

C# 

[CLSCompliant(false)]
public static implicit operator OpcResult(uint? value)

Implicit(Nullable<UInt64> to OpcResult)

Converts a nullable UInt64 to an OpcResult object.

C# 

[CLSCompliant(false)]
public static implicit operator OpcResult(ulong? value)

Implicit(OpcStatus to OpcResult)

Converts a OpcStatus to an OpcResult object.

C# 

public static implicit operator OpcResult(OpcStatus value)

Implicit(OpcStatusCode to OpcResult)

Converts a OpcStatusCode to an OpcResult object.

C# 

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

Implicit(SByte to OpcResult)

Converts a SByte to an OpcResult object.

C# 

[CLSCompliant(false)]
public static implicit operator OpcResult(sbyte value)

Implicit(ServiceResult to OpcResult)

Converts a ServiceResult to an OpcResult object.

C# 

[CLSCompliant(false)]
public static implicit operator OpcResult(ServiceResult value)

Implicit(Single to OpcResult)

Converts a Single to an OpcResult object.

C# 

public static implicit operator OpcResult(float value)

Implicit(StatusCode to OpcResult)

Converts a StatusCode to an OpcResult object.

C# 

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

Implicit(UInt16 to OpcResult)

Converts a UInt16 to an OpcResult object.

C# 

[CLSCompliant(false)]
public static implicit operator OpcResult(ushort value)

Implicit(UInt32 to OpcResult)

Converts a UInt32 to an OpcResult object.

C# 

[CLSCompliant(false)]
public static implicit operator OpcResult(uint value)

Implicit(UInt64 to OpcResult)

Converts a UInt64 to an OpcResult object.

C# 

[CLSCompliant(false)]
public static implicit operator OpcResult(ulong value)

Inequality(OpcResult, OpcResult)

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

C# 

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

LessThan(OpcResult, OpcResult)

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

C# 

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


Exceptions

ArgumentNullException

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

LessThanOrEqual(OpcResult, OpcResult)

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

C# 

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


Exceptions

ArgumentNullException

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