DeviceDescriptionFinding Class¶

One entry of a device description the node could not take as written, and what it did instead.

public sealed class DeviceDescriptionFinding

Inheritance Object → DeviceDescriptionFinding

Constructors¶

DeviceDescriptionFinding(ushort, byte, DeviceDescriptionOutcome, string, string, Nullable<SdoAbortCode>) Constructor¶

Constructs a finding.

public DeviceDescriptionFinding(ushort index, byte subindex, CanKit.Pro.CANopen.DeviceDescriptionOutcome outcome, string reason, string? describedValue=null, System.Nullable<CanKit.Pro.CANopen.Sdo.SdoAbortCode> abortCode=null);

Parameters¶

index UInt16

subindex Byte

outcome DeviceDescriptionOutcome

reason String

describedValue String

abortCode Nullable<SdoAbortCode >

Properties¶

DeviceDescriptionFinding.AbortCode Property¶

The SDO abort code the value was rejected with, when a validation rule rejected it — the same code a master writing that value would receive.

public System.Nullable<CanKit.Pro.CANopen.Sdo.SdoAbortCode> AbortCode { get; }

Property Value¶

Nullable<SdoAbortCode >

DeviceDescriptionFinding.DescribedValue Property¶

The value the description gave, as written in the file, when the finding is about a value.

public string? DescribedValue { get; }

Property Value¶

String

DeviceDescriptionFinding.Index Property¶

Object index.

public ushort Index { get; }

Property Value¶

UInt16

DeviceDescriptionFinding.Outcome Property¶

What the node did.

public CanKit.Pro.CANopen.DeviceDescriptionOutcome Outcome { get; }

Property Value¶

DeviceDescriptionOutcome

DeviceDescriptionFinding.Reason Property¶

Why, in words.

public string Reason { get; }

Property Value¶

String

DeviceDescriptionFinding.Subindex Property¶

Sub-index (0 for a VAR object).

public byte Subindex { get; }

Property Value¶

Byte

Methods¶

DeviceDescriptionFinding.ToString() Method¶

Returns a string that represents the current object.

public override string ToString();

Returns¶

String
A string that represents the current object.