---

SoTimerQueueSensor Class Reference

The SoTimerQueueSensor class is the abstract base class for sensors triggering on certain timer events. More...

#include <Inventor/sensors/SoTimerQueueSensor.h>

Inheritance diagram for SoTimerQueueSensor::

List of all members.

Public Methods
	SoTimerQueueSensor (void)
	SoTimerQueueSensor (SoSensorCB *func, void *data)
virtual	~SoTimerQueueSensor (void)
const SbTime &	getTriggerTime (void) const
virtual void	schedule (void)
virtual void	unschedule (void)
virtual SbBool	isScheduled (void) const
virtual void	trigger (void)
Protected Methods
void	setTriggerTime (const SbTime &time)
Protected Attributes
SbBool	scheduled

---

Detailed Description

The SoTimerQueueSensor class is the abstract base class for sensors triggering on certain timer events.

Timer sensors triggers upon specific points in time. If a timer sensor can not trigger at the exact moment it has been scheduled (due to other activity in Coin, a task suspended or heavy load from other applications on the system), it will be triggered at the first opportunity after the scheduled time has passed.

See the documentation of the subclasses for information on what ways there are to specify times, intervals, etc.

---

Constructor & Destructor Documentation

SoTimerQueueSensor::SoTimerQueueSensor (  void )

Default constructor.

SoTimerQueueSensor::SoTimerQueueSensor (  SoSensorCB * func, void * data )

Constructor taking as arguments the sensor callback function and the userdata which will be passed the callback. See also: setFunction(), setData()

SoTimerQueueSensor::~SoTimerQueueSensor (  void )  [virtual]

Destructor.

---

Member Function Documentation

const SbTime & SoTimerQueueSensor::getTriggerTime (  void )  const

Returns the time at which the sensor will trigger. See also: setTriggerTime()

void SoTimerQueueSensor::schedule (  void )  [virtual]

Put the sensor in the global timer queue. See also: unschedule(), isScheduled() Reimplemented from SoSensor. Reimplemented in SoTimerSensor, and SoAlarmSensor.

void SoTimerQueueSensor::unschedule (  void )  [virtual]

Remove sensor from the timer queue, without triggering it first. See also: schedule(), isScheduled() Reimplemented from SoSensor. Reimplemented in SoTimerSensor.

SbBool SoTimerQueueSensor::isScheduled (  void )  const [virtual]

Check if this sensor is scheduled for triggering. See also: schedule(), unschedule() Reimplemented from SoSensor.

void SoTimerQueueSensor::trigger (  void )  [virtual]

Overloaded to clear scheduled flag before triggering. Reimplemented from SoSensor.

void SoTimerQueueSensor::setTriggerTime (  const SbTime & time )  [protected]

Set absolute time at which to trigger sensor. See also: getTriggerTime()

---

Member Data Documentation

SbBool SoTimerQueueSensor::scheduled [protected]

TRUE if the sensor is currently scheduled.

---

The documentation for this class was generated from the following files:

• SoTimerQueueSensor.cpp
• SoTimerQueueSensor.h

---