Kanzi 3.9.10
ActivityStatus Enum Reference

Legacy version of enum "kanzi.ActivityConcept.Status". More...

Inheritance diagram for ActivityStatus:
[legend]

Public Member Functions

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

Public Attributes

 Activating =(2)
 The Activity is transitioning into the active state.
 
 Active =(0)
 The Activity is active.
 
 Deactivating =(3)
 The Activity is transitioning into the inactive state.
 
 Inactive =(1)
 The Activity is inactive.
 

Detailed Description

Legacy version of enum "kanzi.ActivityConcept.Status".


Defines possible states of an Activity.
Activity Host nodes can activate and deactivate their child Activities.
This enumeration defines the possible states of an Activity during the
the process of activation and deactivation.
You can use this functionality to react to changes in Activity status in
your application code and in Kanzi Studio.

See also
Activity, StatusProperty

Constructor & Destructor Documentation

◆ ActivityStatus() [1/2]

ActivityStatus ( int value)

Constructs a ActivityStatus of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ ActivityStatus() [2/2]

Constructs a copy of a ActivityStatus object.

Parameters
enum_ActivityStatus 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 ActivityStatus 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 ActivityStatus 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

◆ Activating

Activating =(2)

The Activity is transitioning into the active state.


In an Exclusive Activity Host while one Activity is in Activating state,
another Activity can be in the Deactivating state at the same time.
In a Parallel Activity Host more than one Activity can be in the Active state
at the same time, therefore any Activity can be in any state.

◆ Active

Active =(0)

The Activity is active.


In an Exclusive Activity Host only one child Activity can be in
the Active state at a time.
In a Parallel Activity Host more than one Activity can be in the Active state
at the same time, therefore any Activity can be in any state.

◆ Deactivating

Deactivating =(3)

The Activity is transitioning into the inactive state.


In an Exclusive Activity Host while one Activity is in Deactivating state,
another Activity can at the same time be in the Activating state.
In a Parallel Activity Host more than one Activity can be in the Active state
at the same time, therefore any Activity can be in any state.

◆ Inactive

Inactive =(1)

The Activity is inactive.


Inactive Activities do not show their content.