Skip to content

LssBitRateDetectionResult Class

The result of DetectAsync(Func<int,ICanBus>, LssBitRateDetectionOptions, CancellationToken).

public sealed class LssBitRateDetectionResult

Inheritance Object → LssBitRateDetectionResult

Constructors

LssBitRateDetectionResult(Nullable<int>, IReadOnlyList<LssBitRateProbe>) Constructor

Constructs a result.

public LssBitRateDetectionResult(System.Nullable<int> bitsPerSecond, System.Collections.Generic.IReadOnlyList<CanKit.Pro.CANopen.Lss.LssBitRateProbe> probes);

Parameters

bitsPerSecond Nullable<Int32>

probes IReadOnlyList<LssBitRateProbe>

Properties

LssBitRateDetectionResult.BitsPerSecond Property

The bit rate of the bus in bits per second, or null when no candidate received a frame within the passes the options allow.

public System.Nullable<int> BitsPerSecond { get; }

Property Value

Nullable<Int32>

LssBitRateDetectionResult.Detected Property

Whether a bit rate was found.

public bool Detected { get; }

Property Value

Boolean

LssBitRateDetectionResult.Probes Property

Every candidate listened at, in the order it was tried, over every pass.

public System.Collections.Generic.IReadOnlyList<CanKit.Pro.CANopen.Lss.LssBitRateProbe> Probes { get; }

Property Value

IReadOnlyList<LssBitRateProbe>

LssBitRateDetectionResult.TableIndex Property

The CiA 301 table index (LssBitTiming, table selector 0) of BitsPerSecond, when the table lists that rate. null otherwise, and for a rate that is not in the table.

public System.Nullable<byte> TableIndex { get; }

Property Value

Nullable<Byte>