TimerRecurrence Enum Reference

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

Inheritance diagram for TimerRecurrence:

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

Static Public Member Functions
static TimerRecurrence	swigToEnum (int swigValue)
	Converts an integer value to the matching enumeration constant. More...
static TimerRecurrence	toEnum (int value)
	Converts an integer value to the matching enumeration constant. More...

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. More...

Detailed Description

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

Enumeration for timer recurrence options.

Constructor & Destructor Documentation

TimerRecurrence

(

int

value

)

Constructs a TimerRecurrence of an integer value.

Parameters

value

Integer value to convert to enumeration constant.

TimerRecurrence

(

TimerRecurrence

enum_

)

Constructs a copy of a TimerRecurrence object.

Parameters

enum_

TimerRecurrence to be copy constructed.

Member Function Documentation

int getValue

(

)

Returns the integer value of the enumeration constant.

Returns

Integer value.

Implements Enum.

static TimerRecurrence swigToEnum ( int  swigValue )

static

Converts an integer value to the matching enumeration constant.

Used internally by SWIG generated code.

Parameters

swigValue

Integer value to convert to enumeration constant.

Returns

Enumeration constant matching the integer value.

final int swigValue

(

)

Returns the integer value of the enumeration constant.

Used internally by SWIG generated code.

Returns

Integer value.

static TimerRecurrence toEnum ( int  value )

static

Converts an integer value to the matching enumeration constant.

Parameters

value

Integer value to convert to enumeration constant.

Returns

Enumeration constant matching the integer value.

Member Data Documentation

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.