Click or drag to resize

IObservingConditionsAveragePeriod Property

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

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.1.0+15bd426746e14ecc59ad81c289f923331d1aae8b
Syntax
Copy
double AveragePeriod { get; set; }

Property Value

Double
Time period (hours) over which to average sensor readings
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.
NotConnectedExceptionWhen Connected is False.
DriverExceptionAn error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself.
Remarks

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

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