OSDP.Net 5.2.1
A .NET library for implementing the Open Supervised Device Protocol (OSDP)
Loading...
Searching...
No Matches
OSDP.Net.LineQuality.LineQualityReport Class Reference

The complete results of a line quality test run. More...

Properties

TestProfile Profile [get]
 Gets the profile the run used.
string Connection [get]
 Gets a description of the connection tested.
byte Address [get]
 Gets the responder address that was tested.
DateTime StartedUtc [get]
 Gets when the run started.
DateTime CompletedUtc [get, set]
 Gets when the run finished.
TimeSpan Duration [get]
 Gets how long the run took.
IReadOnlyList< BaudRateResult > BaudRates [get]
 Gets the per-baud-rate results, in the order they were exercised.
int IterationsPerCombination [get]
 Gets the number of iterations run for each pattern and payload combination.
int? RecommendedBaudRate [get]
 Gets the highest baud rate that passed, or null when none did.
LineQualityVerdict OverallVerdict [get]
 Gets the overall verdict: the best result achieved at any rate.

Detailed Description

The complete results of a line quality test run.

Definition at line 222 of file LineQualityReport.cs.

Property Documentation

◆ Address

byte OSDP.Net.LineQuality.LineQualityReport.Address
get

Gets the responder address that was tested.

Definition at line 241 of file LineQualityReport.cs.

◆ BaudRates

IReadOnlyList<BaudRateResult> OSDP.Net.LineQuality.LineQualityReport.BaudRates
get

Gets the per-baud-rate results, in the order they were exercised.

Definition at line 253 of file LineQualityReport.cs.

◆ CompletedUtc

DateTime OSDP.Net.LineQuality.LineQualityReport.CompletedUtc
getset

Gets when the run finished.

Definition at line 247 of file LineQualityReport.cs.

◆ Connection

string OSDP.Net.LineQuality.LineQualityReport.Connection
get

Gets a description of the connection tested.

Definition at line 238 of file LineQualityReport.cs.

◆ Duration

TimeSpan OSDP.Net.LineQuality.LineQualityReport.Duration
get

Gets how long the run took.

Definition at line 250 of file LineQualityReport.cs.

◆ IterationsPerCombination

int OSDP.Net.LineQuality.LineQualityReport.IterationsPerCombination
get

Gets the number of iterations run for each pattern and payload combination.

Definition at line 258 of file LineQualityReport.cs.

◆ OverallVerdict

LineQualityVerdict OSDP.Net.LineQuality.LineQualityReport.OverallVerdict
get

Gets the overall verdict: the best result achieved at any rate.

Definition at line 276 of file LineQualityReport.cs.

◆ Profile

TestProfile OSDP.Net.LineQuality.LineQualityReport.Profile
get

Gets the profile the run used.

Definition at line 235 of file LineQualityReport.cs.

◆ RecommendedBaudRate

int? OSDP.Net.LineQuality.LineQualityReport.RecommendedBaudRate
get

Gets the highest baud rate that passed, or null when none did.

Only a pass counts. A marginal result means the line is carrying errors already, which is not a basis for choosing an operating rate.

Definition at line 267 of file LineQualityReport.cs.

◆ StartedUtc

DateTime OSDP.Net.LineQuality.LineQualityReport.StartedUtc
get

Gets when the run started.

Definition at line 244 of file LineQualityReport.cs.

The documentation for this class was generated from the following file: