Kanzi 3.9.10
TimerRecurrence Enum Reference

Legacy version of enum "kanzi.MainLoopScheduler.TimerRecurrence". More...

Inheritance diagram for TimerRecurrence:
[legend]

Public Member Functions

 TimerRecurrence (int value)
 Constructs a TimerRecurrence of an integer value.
 
 TimerRecurrence (TimerRecurrence enum_)
 Constructs a copy of a TimerRecurrence object.
 
int getValue ()
 Returns the integer value of the enumeration constant.
 
final int swigValue ()
 Returns the integer value of the enumeration constant.
 

Static Public Member Functions

static TimerRecurrence swigToEnum (int swigValue)
 Converts an integer value to the matching enumeration constant.
 
static TimerRecurrence toEnum (int value)
 Converts an integer value to the matching enumeration constant.
 

Public Attributes

 OneTime =(1)
 Kanzi executes the timer once in a main loop iteration where the specified time since their addition has elapsed.
 
 Recurring =(0)
 Kanzi executes the timer tasks periodically at specified intervals.
 

Detailed Description

Legacy version of enum "kanzi.MainLoopScheduler.TimerRecurrence".


Enumeration for timer recurrence options.

Constructor & Destructor Documentation

◆ TimerRecurrence() [1/2]

TimerRecurrence ( int value)

Constructs a TimerRecurrence of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ TimerRecurrence() [2/2]

Constructs a copy of a TimerRecurrence object.

Parameters
enum_TimerRecurrence to be copy constructed.

Member Function Documentation

◆ getValue()

int getValue ( )

Returns the integer value of the enumeration constant.

Returns
Integer value.

Implements Enum.

◆ swigToEnum()

static TimerRecurrence swigToEnum ( int swigValue)
static

Converts an integer value to the matching enumeration constant.

Used internally by SWIG generated code.

Parameters
swigValueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.

◆ swigValue()

final int swigValue ( )

Returns the integer value of the enumeration constant.

Used internally by SWIG generated code.

Returns
Integer value.

◆ toEnum()

static TimerRecurrence toEnum ( int value)
static

Converts an integer value to the matching enumeration constant.

Parameters
valueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.

Member Data Documentation

◆ Recurring

Recurring =(0)

Kanzi executes the timer tasks periodically at specified intervals.

When a recurring timer elapses multiple times in a single iteration
of the Kanzi main loop, Kanzi executes that timer only once, but provides the number of elapsed intervals through its callback interface.