IObservingConditions.AveragePeriod Property

IObservingConditionsAveragePeriod Property

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

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.2.0.2774)

Syntax

C++

Copy

double AveragePeriod { get; set; }

Property AveragePeriod As Double
	Get
	Set

property double AveragePeriod {
	double get ();
	void set (double value);
}

Property Value

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

Exceptions

Exception	Condition
InvalidValueException	If the value set is not available for this driver. All drivers must accept 0.0 to specify that an instantaneous value is available.
NotConnectedException	If the device is not connected and this information is only available when connected.

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.

Reference

IObservingConditions Interface

ASCOM.DeviceInterface Namespace