Kanzi 4.1.0
ValueAccumulatorBaseEnums.IncrementMode Enum Reference

Defines how a Value Accumulator increments the accumulated value. More...

Inheritance diagram for ValueAccumulatorBaseEnums.IncrementMode:
[legend]

Public Member Functions

 IncrementMode (IncrementMode enum_)
 Constructs a copy of a IncrementMode object.
 
 IncrementMode (int value)
 Constructs a IncrementMode of an integer value.
 
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 IncrementMode swigToEnum (int swigValue)
 Converts an integer value to the matching enumeration constant.
 
static IncrementMode toEnum (int value)
 Converts an integer value to the matching enumeration constant.
 

Public Attributes

 PerFrame =(1)
 Increments once per frame, ignoring time delta.
 
 TimeBased =(0)
 Increments based on time intervals (milliseconds).
 

Detailed Description

Defines how a Value Accumulator increments the accumulated value.

Constructor & Destructor Documentation

◆ IncrementMode() [1/2]

IncrementMode ( int value)

Constructs a IncrementMode of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ IncrementMode() [2/2]

Constructs a copy of a IncrementMode object.

Parameters
enum_IncrementMode 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 IncrementMode 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 IncrementMode 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

◆ PerFrame

PerFrame =(1)

Increments once per frame, ignoring time delta.

Use this mode for frame counters.

◆ TimeBased

TimeBased =(0)

Increments based on time intervals (milliseconds).

This is the default mode.