IObservingConditions.SensorDescription Method

IObservingConditionsSensorDescription Method

Provides a description of the sensor providing the requested property

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

Syntax

C++

Copy

string SensorDescription(
	string PropertyName
)

Function SensorDescription ( 
	PropertyName As String
) As String

String^ SensorDescription(
	String^ PropertyName
)

Parameters

PropertyName: Type: SystemString
Name of the sensor whose description is required

Return Value

Type: String
The description of the specified sensor.

Exceptions

Exception	Condition
MethodNotImplementedException	If the sensor is not implemented.
NotConnectedException	If the device is not connected and this information is only available when connected.
InvalidValueException	If an invalid property name parameter is supplied.

Remarks

Must Not throw a MethodNotImplementedException when the specified sensor Is implemented but must throw a MethodNotImplementedException when the specified sensor Is Not implemented.

PropertyName must be the name of one of the sensor properties specified in the IObservingConditions interface. If the caller supplies some other value, throw an InvalidValueException.

If the sensor is implemented, this must return a valid string, even if the driver is not connected, so that applications can use this to determine what sensors are available.

If the sensor is not implemented, this must throw a MethodNotImplementedException.

Reference

IObservingConditions Interface

ASCOM.DeviceInterface Namespace