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

Results for every combination exercised at a single baud rate. More...

Properties

int BaudRate [get]
 Gets the baud rate these results describe.
IReadOnlyList< CombinationResult > Combinations [get]
 Gets the per-combination results.
string SkipReason [get, set]
 Gets the reason the rate was not exercised because the responder cannot do it, or null.
string FailureReason [get, set]
 Gets the reason the rate failed before any packets could be measured, or null.
bool WasTested [get]
 Gets a value indicating whether any packets were sent at this rate.
int PacketsSent [get]
 Gets the total number of echo requests sent at this rate.
int PacketsReceived [get]
 Gets the total number of correct echoes received at this rate.
int Timeouts [get]
 Gets the total number of timeouts at this rate.
int IntegrityErrors [get]
 Gets the total number of integrity failures at this rate.
int Naks [get]
 Gets the total number of NAK replies at this rate.
int PatternMismatches [get]
 Gets the total number of pattern mismatches at this rate.
int Failures [get]
 Gets the total number of failures of any kind at this rate.
double SuccessRatePercent [get]
 Gets the proportion of requests that produced a correct echo, as a percentage.
double MaxResponseTimeMs [get]
 Gets the longest response time observed at this rate, in milliseconds.
double AverageResponseTimeMs [get]
 Gets the mean response time across every successful exchange at this rate.
double DetectionLimitPercent [get]
 Gets the smallest packet loss rate this run could have ruled out, as a percentage.
LineQualityVerdict Verdict [get]
 Gets the assessment for this baud rate, per section 6.1 of the test procedure.

Detailed Description

Results for every combination exercised at a single baud rate.

Definition at line 87 of file LineQualityReport.cs.

Property Documentation

◆ AverageResponseTimeMs

double OSDP.Net.LineQuality.BaudRateResult.AverageResponseTimeMs
get

Gets the mean response time across every successful exchange at this rate.

Definition at line 154 of file LineQualityReport.cs.

◆ BaudRate

int OSDP.Net.LineQuality.BaudRateResult.BaudRate
get

Gets the baud rate these results describe.

Definition at line 97 of file LineQualityReport.cs.

◆ Combinations

IReadOnlyList<CombinationResult> OSDP.Net.LineQuality.BaudRateResult.Combinations
get

Gets the per-combination results.

Definition at line 100 of file LineQualityReport.cs.

◆ DetectionLimitPercent

double OSDP.Net.LineQuality.BaudRateResult.DetectionLimitPercent
get

Gets the smallest packet loss rate this run could have ruled out, as a percentage.

A verdict of LineQualityVerdict.Pass means only that loss is below this figure, not that it is zero.

Definition at line 172 of file LineQualityReport.cs.

◆ FailureReason

string OSDP.Net.LineQuality.BaudRateResult.FailureReason
getset

Gets the reason the rate failed before any packets could be measured, or null.

Set when the baud rate change did not complete: the responder never acknowledged it, or acknowledged it and then could not be reached. Section 6.1 counts an incomplete rate change as a failure of that rate, because the line could not carry it.

Definition at line 119 of file LineQualityReport.cs.

◆ Failures

int OSDP.Net.LineQuality.BaudRateResult.Failures
get

Gets the total number of failures of any kind at this rate.

Definition at line 143 of file LineQualityReport.cs.

◆ IntegrityErrors

int OSDP.Net.LineQuality.BaudRateResult.IntegrityErrors
get

Gets the total number of integrity failures at this rate.

Definition at line 134 of file LineQualityReport.cs.

◆ MaxResponseTimeMs

double OSDP.Net.LineQuality.BaudRateResult.MaxResponseTimeMs
get

Gets the longest response time observed at this rate, in milliseconds.

Definition at line 150 of file LineQualityReport.cs.

◆ Naks

int OSDP.Net.LineQuality.BaudRateResult.Naks
get

Gets the total number of NAK replies at this rate.

Definition at line 137 of file LineQualityReport.cs.

◆ PacketsReceived

int OSDP.Net.LineQuality.BaudRateResult.PacketsReceived
get

Gets the total number of correct echoes received at this rate.

Definition at line 128 of file LineQualityReport.cs.

◆ PacketsSent

int OSDP.Net.LineQuality.BaudRateResult.PacketsSent
get

Gets the total number of echo requests sent at this rate.

Definition at line 125 of file LineQualityReport.cs.

◆ PatternMismatches

int OSDP.Net.LineQuality.BaudRateResult.PatternMismatches
get

Gets the total number of pattern mismatches at this rate.

Definition at line 140 of file LineQualityReport.cs.

◆ SkipReason

string OSDP.Net.LineQuality.BaudRateResult.SkipReason
getset

Gets the reason the rate was not exercised because the responder cannot do it, or null.

A responder limitation says nothing about the cable, so a rate skipped for this reason is LineQualityVerdict.Untested rather than a failure.

Definition at line 109 of file LineQualityReport.cs.

◆ SuccessRatePercent

double OSDP.Net.LineQuality.BaudRateResult.SuccessRatePercent
get

Gets the proportion of requests that produced a correct echo, as a percentage.

Definition at line 146 of file LineQualityReport.cs.

◆ Timeouts

int OSDP.Net.LineQuality.BaudRateResult.Timeouts
get

Gets the total number of timeouts at this rate.

Definition at line 131 of file LineQualityReport.cs.

◆ Verdict

LineQualityVerdict OSDP.Net.LineQuality.BaudRateResult.Verdict
get

Gets the assessment for this baud rate, per section 6.1 of the test procedure.

The bands overlap, so they are applied worst-first: a run that would qualify as a pass on failure count can still be marginal on timing.

Definition at line 181 of file LineQualityReport.cs.

◆ WasTested

bool OSDP.Net.LineQuality.BaudRateResult.WasTested
get

Gets a value indicating whether any packets were sent at this rate.

Definition at line 122 of file LineQualityReport.cs.

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