AddMinimumDistanceSensor Method

Description

Adds a minimum distance sensor to the sensors collection.

Syntax

Visual Basic
Public Function AddMinimumDistanceSensor( _ ByVal Element1 As Object, _ ByVal Element2 As Object, _ ByVal Name As String, _ ByVal Description As String, _ ByVal LowerRange As Double, _ ByVal UpperRange As Double, _ ByVal MinimumThreshold As Double, _ ByVal MaximumThreshold As Double, _ ByVal Operator As SensorOperatorConstants, _ ByVal DisplayType As SensorDisplayTypeConstants, _ ByVal UpdateMechanism As SensorUpdateMechanismConstants _ ) As Object

Visual Basic

Public Function AddMinimumDistanceSensor( _
   ByVal Element1 As Object, _
   ByVal Element2 As Object, _
   ByVal Name As String, _
   ByVal Description As String, _
   ByVal LowerRange As Double, _
   ByVal UpperRange As Double, _
   ByVal MinimumThreshold As Double, _
   ByVal MaximumThreshold As Double, _
   ByVal Operator As SensorOperatorConstants, _
   ByVal DisplayType As SensorDisplayTypeConstants, _
   ByVal UpdateMechanism As SensorUpdateMechanismConstants _
) As Object

Parameters

Element1

Specifies the first object between which the minimum distance is to be reported.

Element2

Specifies the second object between which the minimum distance is to be reported.

Name

Specifies the name of the sensor.

Description

Contains a description for the sensor.

LowerRange

Specifies the lower value of the sensor's range, providing a mechanism for controlling the sensitivity of the sensor.

UpperRange

Specifies the upper value of the sensor's range.

MinimumThreshold

Specifies the minimum value of the threshold for the sensor.

MaximumThreshold

Specifies the maximum value of the threshold for the sensor.

Operator

Value	Description
seSensorOperatorBetween	Sensor operator - between
seSensorOperatorEqualTo	Sensor operator - equal to
seSensorOperatorGreaterThan	Sensor operator - greater than
seSensorOperatorInvalid	Invalid sensor operator
seSensorOperatorLessThan	Sensor operator - less than
seSensorOperatorNotBetween	Sensor operator - not between
seSensorOperatorNotEqualTo	Sensor operator - not equal to

Specifies the mathematical operator to be used for testing the sensor value against the threshold value. Valid values are members of the SensorOperatorConstants constant set.

DisplayType

Value	Description
seSensorDisplayTypeHorizontalRange	Sensor display - horizontal range
seSensorDisplayTypeInvalid	Invalid sensor display
seSensorDisplayTypeTrueFalse	Sensor display - true/false

Specifies the type of sensor display to use, either range type or true/false. Valid values are members of the SensorDisplayTypeConstants constant set.

UpdateMechanism

Value	Description
seSensorUpdateMechanismAutomatic	Automatic sensor update
seSensorUpdateMechanismInvalid	Invalid sensor update mechanism
seSensorUpdateMechanismManual	Manual sensor update

Specifies whether the sensor is to update manually or automatically. Valid values are members of the SensorUpdateMechanismConstants constant set.