.TH "SoAlarmSensor" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoAlarmSensor \- The \fBSoAlarmSensor\fP class is a sensor which will trigger once at a specified time\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/sensors/SoAlarmSensor\&.h>\fP
.PP
Inherits \fBSoTimerQueueSensor\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSoAlarmSensor\fP (void)"
.br
.ti -1c
.RI "\fBSoAlarmSensor\fP (SoSensorCB *\fBfunc\fP, void *data)"
.br
.ti -1c
.RI "virtual \fB~SoAlarmSensor\fP (void)"
.br
.ti -1c
.RI "void \fBsetTime\fP (const \fBSbTime\fP &abstime)"
.br
.ti -1c
.RI "void \fBsetTimeFromNow\fP (const \fBSbTime\fP &reltime)"
.br
.ti -1c
.RI "const \fBSbTime\fP & \fBgetTime\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBschedule\fP (void)"
.br
.in -1c

Public Member Functions inherited from \fBSoTimerQueueSensor\fP
.in +1c
.ti -1c
.RI "\fBSoTimerQueueSensor\fP (void)"
.br
.ti -1c
.RI "\fBSoTimerQueueSensor\fP (SoSensorCB *\fBfunc\fP, void *data)"
.br
.ti -1c
.RI "virtual \fB~SoTimerQueueSensor\fP (void)"
.br
.ti -1c
.RI "const \fBSbTime\fP & \fBgetTriggerTime\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBunschedule\fP (void)"
.br
.ti -1c
.RI "virtual SbBool \fBisScheduled\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBtrigger\fP (void)"
.br
.in -1c

Public Member Functions inherited from \fBSoSensor\fP
.in +1c
.ti -1c
.RI "\fBSoSensor\fP (void)"
.br
.ti -1c
.RI "\fBSoSensor\fP (SoSensorCB *\fBfunc\fP, void *data)"
.br
.ti -1c
.RI "virtual \fB~SoSensor\fP (void)"
.br
.ti -1c
.RI "void \fBsetFunction\fP (SoSensorCB *callbackfunction)"
.br
.ti -1c
.RI "SoSensorCBPtr \fBgetFunction\fP (void) const"
.br
.ti -1c
.RI "void \fBsetData\fP (void *callbackdata)"
.br
.ti -1c
.RI "void * \fBgetData\fP (void) const"
.br
.ti -1c
.RI "void \fBsetNextInQueue\fP (\fBSoSensor\fP *next)"
.br
.ti -1c
.RI "\fBSoSensor\fP * \fBgetNextInQueue\fP (void) const"
.br
.in -1c
.SS "Additional Inherited Members"


Static Public Member Functions inherited from \fBSoSensor\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c

Protected Member Functions inherited from \fBSoTimerQueueSensor\fP
.in +1c
.ti -1c
.RI "void \fBsetTriggerTime\fP (const \fBSbTime\fP &time)"
.br
.in -1c

Protected Attributes inherited from \fBSoTimerQueueSensor\fP
.in +1c
.ti -1c
.RI "SbBool \fBscheduled\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoSensor\fP
.in +1c
.ti -1c
.RI "SoSensorCB * \fBfunc\fP"
.br
.ti -1c
.RI "void * \fBfuncData\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoAlarmSensor\fP class is a sensor which will trigger once at a specified time\&. 

\fBSoAlarmSensor\fP provides a convenient way of setting up triggers for jobs which should be executed only once when they are scheduled\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoAlarmSensor::SoAlarmSensor (void )"
Default constructor\&. 
.SS "SoAlarmSensor::SoAlarmSensor (SoSensorCB * func, void * data)"
Constructor taking as parameters the sensor callback function and the userdata which will be passed to the callback\&.

.PP
\fBSee also\fP
.RS 4
\fBsetFunction()\fP, \fBsetData()\fP 
.RE
.PP

.SS "SoAlarmSensor::~SoAlarmSensor (void )\fR [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "void SoAlarmSensor::setTime (const \fBSbTime\fP & abstime)"
Set the time at which the sensor will trigger\&.

.PP
Note that you must manually \fBschedule()\fP the sensor after calling this method\&.

.PP
\fBSee also\fP
.RS 4
\fBsetTimeFromNow()\fP, \fBgetTime()\fP 
.RE
.PP

.SS "void SoAlarmSensor::setTimeFromNow (const \fBSbTime\fP & reltime)"
Set the alarm to be triggered at a specified offset from the current time\&.

.PP
Note that you must manually \fBschedule()\fP the sensor after calling this method\&.

.PP
\fBSee also\fP
.RS 4
\fBsetTime()\fP, \fBgetTime()\fP 
.RE
.PP

.SS "const \fBSbTime\fP & SoAlarmSensor::getTime (void ) const"
Returns the trigger time for the alarm as an absolute value from 1970-01-01 00:00:00\&.

.PP
\fBSee also\fP
.RS 4
\fBsetTime()\fP, \fBsetTimeFromNow()\fP 
.RE
.PP

.SS "void SoAlarmSensor::schedule (void )\fR [virtual]\fP"
Put the sensor in the global timer queue\&.

.PP
\fBSee also\fP
.RS 4
\fBunschedule()\fP, \fBisScheduled()\fP 
.RE
.PP

.PP
Reimplemented from \fBSoTimerQueueSensor\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.