SoTimerQueueSensor.3coin4 - Online Linux Manual Page

SoTimerQueueSensor - Online Linux Manual PageSection : 3
Updated : Mon Jan 25 2021
Source : Version 4.0.0
Note : Coin

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

SYNOPSIS
#include <Inventor/sensors/SoTimerQueueSensor.h> Inherits SoSensor. Inherited by SoAlarmSensor, and SoTimerSensor.

Public Member FunctionsSoTimerQueueSensor (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 Member Functionsvoid setTriggerTime (const SbTime &time)

Protected AttributesSbBool scheduled

Additional Inherited Members

Detailed DescriptionThe SoTimerQueueSensor class is the abstract base class for sensors triggering on certain timer events. Timer sensors triggers upon specific points in time. This class is an abstract superclass which collects the common interface of the various non-abstract timer sensor classes. See the documentation of the subclasses for information on what ways there are to specify base times, intervals, alarm-style single triggering, repeated triggers, etc. Note that Coin timer sensors should in no way be considered 'hard real-time'. That is, you can not expect a timer to always trigger at the exact moment it was set up for. Delays in triggering could be due to other activities in Coin, a task suspended, or heavy load from other applications on the system. These situations could all cause the processing of sensor queues (from SoQt / SoWin / SoXt / whatever) to be slightly delayed, thereby causing delays in timer sensor triggering. On modern systems, a timer will usually trigger within a few milliseconds of it's designated time, though. If a timer sensor can not trigger at the exact moment it has been scheduled, it will be triggered at the first opportunity after the scheduled time has passed. Here's a simple usage example. It's a stand-alone example, which only demonstrates how to set up a repeating timer sensor with a callback: #include <Inventor/Xt/SoXt.h> #include <Inventor/sensors/SoTimerSensor.h> #include <cstdio> static void timeSensorCallback(void * data, SoSensor * sensor) { SbTime time = SbTime::getTimeOfDay(); SbString string = time.format("%S.%i"); (void)printf("%s\n", string\&.getString()); } int main(int argc, char ** argv) { SoXt::init("test"); SoTimerSensor * timeSensor = new SoTimerSensor; timeSensor->setFunction(timeSensorCallback); timeSensor->setBaseTime(SbTime::getTimeOfDay()); timeSensor->setInterval(1.0f); timeSensor->schedule(); SoXt::mainLoop(); return 0; }

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) constReturns 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() Implements 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() Implements SoSensor. Reimplemented in SoTimerSensor.

SbBool SoTimerQueueSensor::isScheduled (void) const [virtual]Check if this sensor is scheduled for triggering. See also schedule(), unschedule() Implements SoSensor.

void SoTimerQueueSensor::trigger (void) [virtual]Trigger the sensor's callback function. 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.

AuthorGenerated automatically by Doxygen for Coin from the source code. 0

Johanes Gumabo

Data Size : 23,937 byte
man-SoTimerQueueSensor.3coin4Build : 2024-12-05, 20:55 :
Visitor Screen : x
Visitor Counter ( page / site ) : 3 / 184,550
Visitor ID : :
Visitor IP : 18.118.166.45 :
Visitor Provider : AMAZON-02 :
Provider Position ( lat x lon ) : 39.962500 x -83.006100 : x
Provider Accuracy Radius ( km ) : 1000 :
Provider City : Columbus :
Provider Province : Ohio , : ,
Provider Country : United States :
Provider Continent : North America :
Visitor Recorder : Version :
Visitor Recorder : Library :
Online Linux Manual Page : Version : Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page : Library : lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page : Library : lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base : Version : Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base : Library : lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36

Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .

If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.