OSDP.Net.LineQuality.CombinationResult Class Reference

Results for a single pattern and payload size at one baud rate. More...

Properties
TestPattern	Pattern [get]
	Gets the pattern exercised.
int	PayloadLength [get]
	Gets the payload length exercised.
int	PacketsSent [get, set]
	Gets the number of echo requests sent.
int	PacketsReceived [get, set]
	Gets the number of correct echoes received.
int	Timeouts [get, set]
	Gets the number of requests that drew no reply within the timeout.
int	IntegrityErrors [get, set]
	Gets the number of replies that arrived but failed their integrity check.
int	Naks [get, set]
	Gets the number of replies that were a NAK.
int	PatternMismatches [get, set]
	Gets the number of replies that passed their integrity check but did not carry the expected sequence number, status, or pattern data.
int	Failures [get]
	Gets the total number of failures of any kind.
double	SuccessRatePercent [get]
	Gets the proportion of requests that produced a correct echo, as a percentage.
double	MinResponseTimeMs [get]
	Gets the shortest observed response time, or zero when nothing was received.
double	MaxResponseTimeMs [get]
	Gets the longest observed response time, or zero when nothing was received.
double	AverageResponseTimeMs [get]
	Gets the mean observed response time, or zero when nothing was received.

Detailed Description

Results for a single pattern and payload size at one baud rate.

Definition at line 28 of file LineQualityReport.cs.

Property Documentation

AverageResponseTimeMs

double OSDP.Net.LineQuality.CombinationResult.AverageResponseTimeMs

get

Gets the mean observed response time, or zero when nothing was received.

Definition at line 79 of file LineQualityReport.cs.

Failures

int OSDP.Net.LineQuality.CombinationResult.Failures

get

Gets the total number of failures of any kind.

Definition at line 66 of file LineQualityReport.cs.

IntegrityErrors

int OSDP.Net.LineQuality.CombinationResult.IntegrityErrors

getset

Gets the number of replies that arrived but failed their integrity check.

Definition at line 54 of file LineQualityReport.cs.

MaxResponseTimeMs

double OSDP.Net.LineQuality.CombinationResult.MaxResponseTimeMs

get

Gets the longest observed response time, or zero when nothing was received.

Definition at line 76 of file LineQualityReport.cs.

MinResponseTimeMs

double OSDP.Net.LineQuality.CombinationResult.MinResponseTimeMs

get

Gets the shortest observed response time, or zero when nothing was received.

Definition at line 73 of file LineQualityReport.cs.

Naks

int OSDP.Net.LineQuality.CombinationResult.Naks

getset

Gets the number of replies that were a NAK.

Definition at line 57 of file LineQualityReport.cs.

PacketsReceived

int OSDP.Net.LineQuality.CombinationResult.PacketsReceived

getset

Gets the number of correct echoes received.

Definition at line 48 of file LineQualityReport.cs.

PacketsSent

int OSDP.Net.LineQuality.CombinationResult.PacketsSent

getset

Gets the number of echo requests sent.

Definition at line 45 of file LineQualityReport.cs.

Pattern

TestPattern OSDP.Net.LineQuality.CombinationResult.Pattern

get

Gets the pattern exercised.

Definition at line 39 of file LineQualityReport.cs.

PatternMismatches

int OSDP.Net.LineQuality.CombinationResult.PatternMismatches

getset

Gets the number of replies that passed their integrity check but did not carry the expected sequence number, status, or pattern data.

Definition at line 63 of file LineQualityReport.cs.

PayloadLength

int OSDP.Net.LineQuality.CombinationResult.PayloadLength

get

Gets the payload length exercised.

Definition at line 42 of file LineQualityReport.cs.

SuccessRatePercent

double OSDP.Net.LineQuality.CombinationResult.SuccessRatePercent

get

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

Definition at line 69 of file LineQualityReport.cs.

Timeouts

int OSDP.Net.LineQuality.CombinationResult.Timeouts

getset

Gets the number of requests that drew no reply within the timeout.

Definition at line 51 of file LineQualityReport.cs.

---

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

• OSDP.Net/LineQuality/LineQualityReport.cs