GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOALARMSENSOR (3)

NAME

SoAlarmSensor — triggers a callback once sometime in the future

CONTENTS

Inherits From
Synopsis
Description
Methods
See Also

INHERITS FROM

SoSensor > SoTimerQueueSensor > SoAlarmSensor

SYNOPSIS

#include <Inventor/sensors/SoAlarmSensor.h>

Methods from class SoAlarmSensor:

       
                    
                     SoAlarmSensor()    
   
                    
                     SoAlarmSensor(SoSensorCB *func, void *data)    
   
                    
                     ~SoAlarmSensor()    
void    
                    
void                 setTime(const SbTime &absTime)    
void    
                    
void                 setTimeFromNow(const SbTime &relTime)    
const SbTime &    
                    
const SbTime &       getTime() const

Methods from class SoTimerQueueSensor:

    const SbTime &    
                    
const SbTime &       getTriggerTime()    
virtual void    
                    
virtual void         schedule()    
virtual void    
                    
virtual void         unschedule()    
virtual SbBool    
                    
virtual SbBool       isScheduled()

Methods from class SoSensor:

    void    
                    
void                 setFunction(SoSensorCB *callbackFunction)    
SoSensorCB *    
                    
SoSensorCB *         getFunction() const    
void    
                    
void                 setData(void *callbackData)    
void *    
                    
void *               getData() const

DESCRIPTION

This type of sensor can be used to schedule a one-time callback 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.

METHODS

       
                    
                     SoAlarmSensor()    
   
                    
                     SoAlarmSensor(SoSensorCB *func, void *data)
Creation methods. The second method takes the callback function and data to be called when the sensor is triggered.

       
                    
                     ~SoAlarmSensor()
Destroys the sensor, freeing up any memory associated with it after unscheduling it.

    void    
                    
void                 setTime(const 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.

    void    
                    
void                 setTimeFromNow(const 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.

    const SbTime &    
                    
const SbTime &       getTime() const
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.

SEE ALSO

SoOneShotSensor, SoTimerSensor, SoTimerQueueSensor, SbTime

Search for    or go to Top of page |  Section 3 |  Main Index


SOALARMSENSOR(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.