Click or drag to resize

ObservingConditionsAveragePeriod Property

Gets and sets the time period over which observations will be averaged

Namespace:  ASCOM.DriverAccess
Assembly:  ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
Copy
public double AveragePeriod { get; set; }

Property Value

Type: Double
Time period (hours) over which to average sensor readings

Implements

IObservingConditionsAveragePeriod
Exceptions
ExceptionCondition
InvalidValueExceptionIf the value set is not available for this driver. All drivers must accept 0.0 to specify that an instantaneous value is available.
NotConnectedExceptionIf the device is not connected.
DriverExceptionAn error occurred that is not described by one of the more specific ASCOM exceptions. The device did not successfully complete the request.
Remarks

Mandatory property, must be implemented, can NOT throw a PropertyNotImplementedException

This property should return the time period (hours) over which sensor readings will be averaged. If your driver is delivering instantaneous sensor readings this property should return a value of 0.0.

Please resist the temptation to throw exceptions when clients query sensor properties when insufficient time has passed to get a true average reading. A best estimate of the average sensor value should be returned in these situations.

See Also