Kanzi  3.9.7
Kanzi Engine API
kanzi::ApplyActivationAction Class Reference

An ApplyActivationAction keeps an Activity node activated for as long as the condition is met in a DataTrigger that contains this action. More...

#include <kanzi/ui/action/apply_activation_action.hpp>

Inheritance diagram for kanzi::ApplyActivationAction:
[legend]

Public Member Functions

 KZ_METACLASS_PROPERTY_TYPE (ActivationPathProperty)
 
 KZ_METACLASS_PROPERTY_TYPE (ActivityHostPathProperty)
 
- Public Member Functions inherited from kanzi::ApplyAction
void apply ()
 Applies an ApplyAction to the node that this action targets. More...
 
void attach (DataTriggerComponent *trigger)
 Attaches an Action to a DataTrigger. More...
 
ApplyActionSharedPtr copy () const
 
void detach ()
 Detaches the Action from the DataTrigger. More...
 
DataTriggerComponentgetTrigger () const
 Returns the pointer to a DataTrigger to which an Action is attached. More...
 
void unapply ()
 Unapplies an ApplyAction by rolling back the changes made on apply(), and restoring the state of the target node to its previous value. More...
 
- Public Member Functions inherited from kanzi::ActionBase
string getName () const
 Returns the name of the action. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers. More...
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
virtual ~PropertyObject ()
 

Static Public Member Functions

static auto create (Domain *domain, string_view name)
 Creates an instance of ApplyActivationAction. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Provides Kanzi Studio editor metadata for ApplyActivationAction. More...
 
- Static Public Member Functions inherited from kanzi::ApplyAction
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Provides the Kanzi Studio editor metadata for the ApplyAction. More...
 
- Static Public Member Functions inherited from kanzi::ActionBase
static ActionBaseSharedPtr loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
 Loads an ActionBase from a kzb file. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Provides the Kanzi Studio editor metadata for the ActionBase. More...
 
template<typename TAction >
static shared_ptr< TAction > loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
 Loads an TAction from a kzb file. More...
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Static Public Attributes

Properties
static PropertyType< string > ActivityHostPathProperty
 Sets the path to an Activity Host node that this Apply Activation action uses to activate an Activity node. More...
 
static PropertyType< string > ActivationPathProperty
 Sets the activation path of an Activity node that this Apply Activation action activates. More...
 

Protected Member Functions

 ApplyActivationAction (Domain *domain, string_view name)
 Creates an Apply Activation action. More...
 
void applyOverride () override
 ApplyAction::applyOverride() implementation. More...
 
ApplyActionSharedPtr clone () const override
 Action::clone() implementation. More...
 
void setPropertyModifierOnTarget ()
 Sets a property modifier for a binding target runtime based on the stored binding. More...
 
void unapplyOverride () override
 ApplyAction::unapplyOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::ApplyAction
 ApplyAction (Domain *domain, string_view name)
 Constructor. More...
 
void applyWhenTargetIsAlive (NodeSharedPtr hostNode, string_view targetPath, AbstractPropertyType targetPropertyType, PropertyValidatorFunctionType isPropertyChangeValid)
 Use this method when Kanzi cannot find the node on which to apply an Action during ApplyAction. More...
 
- Protected Member Functions inherited from kanzi::ActionBase
 ActionBase (Domain *domain, string_view name)
 Constructor. More...
 
virtual void load (KzbFile &, KzbMemoryParser &parser)
 Overridable function for loading an action from a kzb file. More...
 
virtual void onAttach ()
 Overridable method called during attach. More...
 
virtual void onDetach ()
 Overridable method called during detach. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
 Notifies all property handlers on a property storage. More...
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Protected Types inherited from kanzi::ApplyAction
using PropertyValidatorFunctionType = function< bool(const Variant &value)>
 Validator function to validate if a change in a property is valid to apply the Action or not. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

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

Examples

To use an ApplyActivationAction to control the activation of an Activity node:

// Create an instance of an Apply Activation action.
auto action = ApplyActivationAction::create(domain, "applyAction");
// Set the name of the target Activity node that you want to activate with the Apply Activation action.
action->setProperty(ApplyActivationAction::ActivationPathProperty, firstActivityName);
// Set the path of the Activity Host node that activates the target Activity node.
// Create a condition expression for the Data Trigger.
// Condition: sourceNode.MyPropertyA == m_sourcePropertyTriggeringValue.
valueSources.push_back(ObjectPropertyExpressionValueSource::create(".", MyPropertyA, PropertyFieldWhole));
operations.push_back(BindingExpressionOpCode(BindingExpressionArgumentTypeSourceRegister0, PropertyFieldWhole,
vector<Variant> constantRegisters;
constantRegisters.emplace_back(m_sourcePropertyTriggeringValue);
// Create an expression binding.
auto binding = ExpressionBinding::create(operations, valueSources, constantRegisters, 2);
auto dataTrigger = DataTrigger::create(domain, "data trigger");
dataTrigger->setConditionExpression(binding);
dataTrigger->addAction(action);
dataTriggerOwner->addNodeComponent(dataTrigger);
screen->attach();
// Since the condition of the Data Trigger is not met, Kanzi does not activate the Activity node that you set in the Apply Activation action::ActivationPathProperty.
dataTriggerOwner->setProperty(MyPropertyA, m_sourcePropertySomeOtherValue1);
domain->getResourceManager()->update();
// As the condition of the Data Trigger is not satisfied,
// the Activity node set in Apply Activation action::ActivationPathProperty will not be activated.
auto firstActivity = activityHost->lookupNode<Node>(firstActivityName);
auto secondActivity = activityHost->lookupNode<Node>(secondActivityName);
assertTrue(!firstActivity);
assertTrue(!secondActivity);
// Set the property of the source node to meet the condition. When the condition is met,
// the trigger sets off the Apply Activation action, and the action activates the Activity node set in the
// ApplyActivationAction::ActivationPathProperty.
dataTriggerOwner->setProperty(MyPropertyA, m_sourcePropertyTriggeringValue);
domain->getResourceManager()->update();
firstActivity = activityHost->lookupNode<Node>(firstActivityName);
secondActivity = activityHost->lookupNode<Node>(secondActivityName);
assertEquals(ActivityConcept::Status::Active, firstActivity->getProperty(ActivityConcept::StatusProperty));
assertTrue(!secondActivity);
// As soon as the condition of the Data Trigger is not met,
// Kanzi deactivates the Activity node set in the ApplyActivationAction::ActivationPathProperty.
dataTriggerOwner->setProperty(MyPropertyA, m_sourcePropertySomeOtherValue2);
domain->getResourceManager()->update();
firstActivity = activityHost->lookupNode<Node>(firstActivityName);
secondActivity = activityHost->lookupNode<Node>(secondActivityName);
assertTrue(!firstActivity);
assertTrue(!secondActivity);

Constructor & Destructor Documentation

kanzi::ApplyActivationAction::ApplyActivationAction ( Domain domain,
string_view  name 
)
explicitprotected

Creates an Apply Activation action.

Parameters
domainDomain to use.
nameName of the action.

Member Function Documentation

kanzi::ApplyActivationAction::KZ_METACLASS_PROPERTY_TYPE ( ActivationPathProperty  )
kanzi::ApplyActivationAction::KZ_METACLASS_PROPERTY_TYPE ( ActivityHostPathProperty  )
static PropertyTypeEditorInfoSharedPtr kanzi::ApplyActivationAction::makeEditorInfo ( )
static

Provides Kanzi Studio editor metadata for ApplyActivationAction.

Returns
Shared pointer to the created PropertyTypeEditorInfo instance.
static auto kanzi::ApplyActivationAction::create ( Domain domain,
string_view  name 
)
inlinestatic

Creates an instance of ApplyActivationAction.

Parameters
domainPointer to the domain.
nameName for the action instance.
Returns
Shared pointer to the created ApplyActivationAction instance.
void kanzi::ApplyActivationAction::applyOverride ( )
overrideprotectedvirtual

ApplyAction::applyOverride() implementation.

Implements kanzi::ApplyAction.

void kanzi::ApplyActivationAction::unapplyOverride ( )
overrideprotectedvirtual
ApplyActionSharedPtr kanzi::ApplyActivationAction::clone ( ) const
overrideprotectedvirtual

Action::clone() implementation.

Implements kanzi::ApplyAction.

void kanzi::ApplyActivationAction::setPropertyModifierOnTarget ( )
protected

Sets a property modifier for a binding target runtime based on the stored binding.

Member Data Documentation

PropertyType<string> kanzi::ApplyActivationAction::ActivityHostPathProperty
static

Sets the path to an Activity Host node that this Apply Activation action uses to activate an Activity node.

By default this property points to the node that owns this action. The default value is ".".

PropertyType<string> kanzi::ApplyActivationAction::ActivationPathProperty
static

Sets the activation path of an Activity node that this Apply Activation action activates.

To activate an Activity node which is a direct child of the Activity Host, set this property to the name of the Activity node. By default this property does not point to any Activity node. The default value is "".


The documentation for this class was generated from the following file: