AddSurfaceAreaSensor Method

Description

Adds a surface area sensor to the sensors collection.

Syntax

Visual Basic
Public Function AddSurfaceAreaSensor( _ ByVal iSensorType As SurfaceAreaSensorAreaTypeConstants, _ ByVal iSelectionType As SurfaceAreaSensorSelectionTypeConstants, _ 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, _ ByRef Element As Variant _ ) As Object

Visual Basic

Public Function AddSurfaceAreaSensor( _
   ByVal iSensorType As SurfaceAreaSensorAreaTypeConstants, _
   ByVal iSelectionType As SurfaceAreaSensorSelectionTypeConstants, _
   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, _
   ByRef Element As Variant _
) As Object

Parameters

iSensorType

Value	Description
seSurfaceAreaSensorAreaTypeNeg	Sensor Surface Area - Negative Area
seSurfaceAreaSensorAreaTypePos	Sensor Surface Area - Positive Area

Member of the SurfaceAreaSensorAreaTypeConstants constant set. Specifies the type of sensor - positive area or negative area - to be added.

iSelectionType

Value	Description
seSurfaceAreaSensorSelectFace	Sensor Surface Area Selection Type - Face
seSurfaceAreaSensorSelectFaceChain	Sensor Surface Area Selection Type - Face Chain

Member of the SurfaceAreaSensorSelectionTypeConstants constant set. Specifies whether faces of a chain of faces are to be selected.

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

Member of the SensorOperatorConstants constant set. Specifies the mathematical operator to be used for testing the sensor value against the threshold value.

DisplayType

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

Member of the SensorDisplayTypeConstants constant set. Specifies the type of sensor display to use, either range type or true/false.

UpdateMechanism

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

Member of the SensorUpdateMechanismConstants constant set. Specifies whether the sensor is to update manually or automatically.

Element

Specifies the face(s) to be evaluated.