com.openinventor.inventor.sensors

Class SoAlarmSensor

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.sensors.SoSensor

com.openinventor.inventor.sensors.SoTimerQueueSensor

com.openinventor.inventor.sensors.SoAlarmSensor

public class SoAlarmSensor
extends SoTimerQueueSensor

Triggers a delegate once sometime in the future. 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:

SoOneShotSensor, SoTimerSensor, SoTimerQueueSensor, SbTime

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoAlarmSensor() Constructor.
SoAlarmSensor(java.lang.Runnable task) Build a new alarm sensor with the task to be executed when the sensor is triggered.

Method Summary

Modifier and Type	Method and Description
SbTime	getTime() Returns the time at which the sensor is set to be triggered.
SbTime	getTriggerTime() Returns the time at which this sensor is scheduled to be triggered.
boolean	isScheduled() Returns true if this sensor has been scheduled and is waiting in a sensor queue to be triggered.
void	schedule()
void	setDelay(long millisec) Deprecated. As of Open Inventor 9.5, use setTimeFromNow(com.openinventor.inventor.SbTime) instead.
void	setTime(SbTime absTime) Sets the sensor to go off at the specified time.
void	setTimeFromNow(SbTime relTime) Sets the sensor to go off the given amount of time from now.
void	unschedule()

Methods inherited from class com.openinventor.inventor.sensors.SoSensor

setTask

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoAlarmSensor

public SoAlarmSensor()

Constructor.

SoAlarmSensor

public SoAlarmSensor(java.lang.Runnable task)

Build a new alarm sensor with the task to be executed when the sensor is triggered.

Method Detail

setDelay

@Deprecated
public void setDelay(long millisec)

Deprecated. As of Open Inventor 9.5, use setTimeFromNow(com.openinventor.inventor.SbTime) instead.

Overrides:

setDelay in class SoTimerQueueSensor

getTriggerTime

public SbTime getTriggerTime()

Description copied from class: SoTimerQueueSensor

Returns the time at which this sensor is scheduled to be triggered. If the sensor is not scheduled the results are undefined.

Overrides:

getTriggerTime in class SoTimerQueueSensor

schedule

public void schedule()

Overrides:

schedule in class SoSensor

unschedule

public void unschedule()

Overrides:

unschedule in class SoSensor

isScheduled

public boolean isScheduled()

Description copied from class: SoSensor

Returns true if this sensor has been scheduled and is waiting in a sensor queue to be triggered. Sensors are removed from the queue before their callback function is triggered.

Overrides:

isScheduled in class SoSensor

setTime

public void setTime(SbTime absTime)

Sets the sensor to go off at the specified time. You must also call schedule() for the sensor to be triggered. If the sensor is already scheduled, it must be unscheduled and then rescheduled for the change in the trigger time to take effect.

setTimeFromNow

public void setTimeFromNow(SbTime relTime)

Sets the sensor to go off the given amount of time from now. You must also call schedule() for the sensor to be triggered. If the sensor is already scheduled, it must be unscheduled and then rescheduled for the change in the trigger time to take effect.

getTime

public SbTime getTime()

Returns the time at which the sensor is set to be triggered. This is similar to the getTriggerTime method, but returns the time even if the sensor has not yet been scheduled.