Click or drag to resize

IObservingConditionsSensorDescription Method

Provides a description of the sensor providing the requested property

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
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
ExceptionCondition
MethodNotImplementedExceptionIf the sensor is not implemented.
InvalidValueExceptionIf an invalid property name parameter is supplied.
NotConnectedExceptionIf the device is not connected.
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

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.

See Also