LssServiceResult Struct¶

Outcome of a confirmed LSS configuration service (configure node-id, configure bit timing, store). A timeout is not an outcome of the service: it is LssTimeoutException (CiA 305 annex A.2).

public readonly struct LssServiceResult : System.IEquatable<CanKit.Pro.CANopen.Lss.LssServiceResult>

Implements IEquatable<LssServiceResult >

Constructors¶

LssServiceResult(byte, byte) Constructor¶

Constructs a result. specError is meaningful only when errorCode is ManufacturerSpecific; otherwise the protocol reserves it and this value is what the slave sent.

public LssServiceResult(byte errorCode, byte specError);

Parameters¶

errorCode Byte

specError Byte

Properties¶

LssServiceResult.ErrorCode Property¶

Error code from the slave. 00h is success. The meaning of the other codes depends on the service (CiA 305 §7.5).

public byte ErrorCode { get; }

Property Value¶

Byte

LssServiceResult.IsManufacturerSpecific Property¶

The slave reported ManufacturerSpecific.

public bool IsManufacturerSpecific { get; }

Property Value¶

Boolean

LssServiceResult.SpecError Property¶

Implementation-specific code. The slave sends it when ErrorCode is ManufacturerSpecific; otherwise the field is reserved.

public byte SpecError { get; }

Property Value¶

Byte

LssServiceResult.Succeeded Property¶

The slave reported success (ErrorCode00h).

public bool Succeeded { get; }

Property Value¶

Boolean

LssServiceResult.Success Property¶

Protocol succeeded.

public static CanKit.Pro.CANopen.Lss.LssServiceResult Success { get; }

Property Value¶

LssServiceResult

Methods¶

LssServiceResult.Equals(object) Method¶

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj);

Parameters¶

obj Object

The object to compare with the current instance.

Returns¶

Boolean
true if obj and this instance are the same type and represent the same value; otherwise, false.

LssServiceResult.GetHashCode() Method¶

Returns the hash code for this instance.

public override int GetHashCode();

Returns¶

Int32
A 32-bit signed integer that is the hash code for this instance.

LssServiceResult.ToString() Method¶

Returns the fully qualified type name of this instance.

public override string ToString();

Returns¶

String
The fully qualified type name.

Operators¶

LssServiceResult.operator ==(LssServiceResult, LssServiceResult) Operator¶

Value equality.

public static bool operator ==(CanKit.Pro.CANopen.Lss.LssServiceResult left, CanKit.Pro.CANopen.Lss.LssServiceResult right);

Parameters¶

left LssServiceResult

right LssServiceResult

Returns¶

Boolean

LssServiceResult.operator !=(LssServiceResult, LssServiceResult) Operator¶

Value inequality.

public static bool operator !=(CanKit.Pro.CANopen.Lss.LssServiceResult left, CanKit.Pro.CANopen.Lss.LssServiceResult right);

Parameters¶

left LssServiceResult

right LssServiceResult

Returns¶

Boolean