Click or drag to resize
SoAlarmSensor Class

Triggers a delegate once sometime in the future.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.SensorsSoSensor
      OIV.Inventor.SensorsSoTimerQueueSensor
        OIV.Inventor.SensorsSoAlarmSensor

Namespace: OIV.Inventor.Sensors
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
Syntax
Copy
public class SoAlarmSensor : SoTimerQueueSensor

The SoAlarmSensor type exposes the following members.

Constructors
  NameDescription
Public methodSoAlarmSensor

Constructor.

Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetTime

Returns the time at which the sensor is set to be triggered.

Public methodGetTriggerTime

Returns the time at which this sensor is scheduled to be triggered.

(Inherited from SoTimerQueueSensor.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsScheduled

Returns true if this sensor has been scheduled and is waiting in a sensor queue to be triggered.

(Inherited from SoSensor.)
Public methodSchedule
(Inherited from SoSensor.)
Public methodSetTime

Sets the sensor to go off at the specified time.

Public methodSetTimeFromNow

Sets the sensor to go off the given amount of time from now.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnschedule
(Inherited from SoSensor.)
Top
Properties
  NameDescription
Public propertyAction

(Inherited from SoSensor.)
Top
Remarks

This type of sensor can be used to schedule a one-time delegate for some time in the future. The sensor is not guaranteed to be called at exactly that time, but will be called sometime after the specified time.

See Also