OSDP.Net.LineQuality.LineQualityOptions Class Reference

Options controlling a line quality test run. More...

Properties
TestProfile	Profile = TestProfile.Screening [get, set]
	Gets or sets the test profile, which sets the iteration count and therefore the smallest loss rate the run can detect.
IReadOnlyList< int >	BaudRates [get, set]
	Gets or sets the baud rates to sweep.
byte	Address = LineQualityProtocol.TestAddress [get, set]
	Gets or sets the responder address.
TimeSpan	ResponseTimeout = TimeSpan.FromMilliseconds(200) [get, set]
	Gets or sets how long to wait for the first byte of a reply.
TimeSpan	BaudRateSettleDelay = TimeSpan.FromMilliseconds(100) [get, set]
	Gets or sets how long to wait after a baud rate change acknowledgment has drained before retuning the port.
bool	ReturnToBaselineWhenDone = true [get, set]
	Gets or sets whether to return the responder to 9600 baud when the run finishes.
IProgress< LineQualityProgress >	Progress [get, set]
	Gets or sets an optional callback receiving progress updates.
Action< TraceEntry >	Tracer [get, set]
	Gets or sets an optional tracer receiving every packet sent and received, for capture to an osdpcap file.

Detailed Description

Options controlling a line quality test run.

Definition at line 10 of file LineQualityOptions.cs.

Property Documentation

Address

byte OSDP.Net.LineQuality.LineQualityOptions.Address = LineQualityProtocol.TestAddress

getset

Gets or sets the responder address.

Defaults to the dedicated test address 125.

Definition at line 28 of file LineQualityOptions.cs.

BaudRates

IReadOnlyList<int> OSDP.Net.LineQuality.LineQualityOptions.BaudRates

getset

Gets or sets the baud rates to sweep.

Defaults to LineQualityProtocol.DefaultBaudRates, the six rates OSDP names.

Definition at line 23 of file LineQualityOptions.cs.

BaudRateSettleDelay

TimeSpan OSDP.Net.LineQuality.LineQualityOptions.BaudRateSettleDelay = TimeSpan.FromMilliseconds(100)

getset

Gets or sets how long to wait after a baud rate change acknowledgment has drained before retuning the port.

Defaults to the 100 ms the test procedure requires.

Definition at line 40 of file LineQualityOptions.cs.

Profile

TestProfile OSDP.Net.LineQuality.LineQualityOptions.Profile = TestProfile.Screening

getset

Gets or sets the test profile, which sets the iteration count and therefore the smallest loss rate the run can detect.

Defaults to TestProfile.Screening.

Definition at line 17 of file LineQualityOptions.cs.

Progress

IProgress<LineQualityProgress> OSDP.Net.LineQuality.LineQualityOptions.Progress

getset

Gets or sets an optional callback receiving progress updates.

Definition at line 51 of file LineQualityOptions.cs.

ResponseTimeout

TimeSpan OSDP.Net.LineQuality.LineQualityOptions.ResponseTimeout = TimeSpan.FromMilliseconds(200)

getset

Gets or sets how long to wait for the first byte of a reply.

Defaults to the 200 ms reply window from OSDP section 5.7.

Definition at line 34 of file LineQualityOptions.cs.

ReturnToBaselineWhenDone

bool OSDP.Net.LineQuality.LineQualityOptions.ReturnToBaselineWhenDone = true

getset

Gets or sets whether to return the responder to 9600 baud when the run finishes.

Defaults to true, so an interrupted installation is left in a known state.

Definition at line 46 of file LineQualityOptions.cs.

Tracer

Action<TraceEntry> OSDP.Net.LineQuality.LineQualityOptions.Tracer

getset

Gets or sets an optional tracer receiving every packet sent and received, for capture to an osdpcap file.

Definition at line 57 of file LineQualityOptions.cs.

---

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

• OSDP.Net/LineQuality/LineQualityOptions.cs