Class ApplyActivationAction

Class Hierarchy

An ApplyActivationAction keeps an Activity node activated for as long as the condition is met in a DataTrigger that contains this action. When the trigger condition is no longer met, Kanzi rolls back the state of the Activity node to the state before the action was applied. Use the ApplyActivationAction only with a DataTrigger.

When you want to control the activation of an Activity, always use a DataTrigger. For example, use one DataTrigger with an ApplyActivationAction instead of using any other trigger to activate an Activity node when the conditions in that trigger are met and another trigger to deactivate the same Activity node when the conditions in the first trigger are no longer met.

An Activity node becomes inactive:

  • In a Parallel Activity Host node when:
  • An Activity node is inactive before you apply an ApplyActivationAction and there is no request to activate that Activity node, when Kanzi is applying the action to deactivate that node.
  • The application requests an Activity node to be inactive when Kanzi is applying an ApplyActivationAction, and no other request to activate that Activity node exists.
  • In an Exclusive Activity Host node, when any other Activity node becomes active or when you apply an ApplyActivationAction, or any other Action, to activate another Activity node.

To activate an Activity node, you can also use ActivityHostConcept::ActivateActivityMessage or ValueControlledExclusiveActivityHostConcept::ControllerProperty.

Since Kanzi 3.9.0

Keeps an Activity node activated for as long as the conditions are met in a Data Trigger that contains this action. When the conditions are no longer met, Kanzi rolls back the state of the Activity node to the state before the action was applied.

Inherits properties and message types from ApplyActivationActionMetadata.

Synopsis

Methods
create()

Creates an instance of ApplyActivationAction

ApplyActivationAction.ApplyActivationAction:create(name)

Creates an instance of ApplyActivationAction.

Parameters
name (string)

Name for the action instance.

Return Values
(ApplyActivationAction)

Shared pointer to the created ApplyActivationAction instance.