Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::DataTrigger Class Reference

Use a DataTrigger to apply an action to either set a property value of a target node or activate an Activity node. More...

#include <kanzi/ui/node_component/trigger/data_trigger.hpp>

Inheritance diagram for kanzi::DataTrigger:
[legend]

Public Member Functions

bool areActionsForced () const
 Returns whether a DataTrigger applies its Actions regardless of the ConditionExpression in that DataTrigger. More...
 
void forceApplyActions ()
 Applies the Actions in a DataTrigger, regardless of the ConditionExpression in that DataTrigger. More...
 
void revokeForceApplyActions ()
 Sets a DataTrigger to apply its Actions only when the ConditionExpression in that DataTrigger evaluates to True. More...
 
 ~DataTrigger () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::DataTriggerComponent
void addAction (ApplyActionSharedPtr action)
 Adds an ApplyAction to the DataTriggerComponent. More...
 
ApplyActionIterator beginActions () const
 Returns an iterator at the beginning of the stored ApplyActions. More...
 
ApplyActionIterator endActions () const
 Returns an iterator at the end of the stored ApplyActions. More...
 
ExpressionBindingSharedPtr getConditionExpression () const
 Gets the input condition of a DataTriggerComponent. More...
 
string getConditionExpressionString () const
 Gets the value of the ConditionExpressionProperty. More...
 
void setConditionExpression (ExpressionBindingSharedPtr binding)
 Sets the input condition for a DataTriggerComponent. More...
 
void setConditionExpressionString (string_view expression)
 Sets the value of the ConditionExpressionProperty. More...
 
- Public Member Functions inherited from kanzi::NodeComponent
void attach (NodeWeakPtr node)
 Attaches node component to node. More...
 
void detach ()
 Detaches node component from the node it was attached to. More...
 
string getName () const
 Gets the name of node component. More...
 
NodeSharedPtr getNode () const
 Returns the node the node component is attached to or null pointer if node component is not attached to a node. More...
 
State getState () const
 Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...
 
bool isAttached () const
 Indicates whether node component is attached to a node. More...
 
bool isAttaching () const
 Indicates whether node component is in the process of attaching to a node. More...
 
bool isAttachingOrAttached () const
 Indicates whether node component is in the process of attaching to a node or already attached. More...
 
bool isDetached () const
 Indicates whether node component is detached from any node. More...
 
bool isDetaching () const
 Indicates whether node component currently detaching from the node. More...
 
bool isDetachingOrDetached () const
 Indicates whether node component is in the process of detaching from the node or already detached. More...
 
void setName (string_view name)
 Sets the name of node component. More...
 
 ~NodeComponent () override
 Destructor. 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)
 Constructor. More...
 
static kanzi::PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::DataTriggerComponent
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Provides the Kanzi Studio editor metadata for the DataTriggerComponent. More...
 
- Static Public Member Functions inherited from kanzi::NodeComponent
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- 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...
 

Protected Member Functions

void applyActions ()
 Applies the ApplyAction actions associated with this Data Trigger. More...
 
void attachOverride () override
 NodeComponent::attachOverride implementation. More...
 
 DataTrigger (Domain *domain, string_view name)
 Constructor. More...
 
void detachOverride () override
 NodeComponent::detachOverride implementation. More...
 
void unapplyActions ()
 Unapplies the ApplyAction actions associated with this Data Trigger. More...
 
- Protected Member Functions inherited from kanzi::DataTriggerComponent
 DataTriggerComponent (Domain *domain, string_view name)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType , typename TClass , typename TMethod >
Node::MessageSubscriptionToken addNodeComponentMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TMethod method)
 Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of this node component, or if the message is broadcast to all node components with an empty target name. More...
 
template<typename TMessageType >
Node::MessageSubscriptionToken addNodeComponentMessageHandler (TMessageType &messageType, typename TMessageType::FunctionType function)
 Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name. More...
 
void dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
 Adds the name of the node component to the abstract message arguments and dispatches the message to the node of the node component. More...
 
template<typename TArgumentsType >
void dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
 Adds the name of the node component to the message arguments and dispatches the message to the node of the node component. More...
 
 NodeComponent (Domain *domain, string_view name)
 Constructor. More...
 
void removeNodeComponentMessageFilter (Node::MessageSubscriptionToken subscriptionToken)
 Removes message handler added via addNodeComponentMessageHandler function. 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::DataTriggerComponent
using ApplyActionContainer = vector< ApplyActionSharedPtr >
 
using ApplyActionIterator = ApplyActionContainer::const_iterator
 
- Public Types inherited from kanzi::NodeComponent
using NodeComponentMessageArguments = NodeComponentTargetMessageArguments
 Legacy name for NodeComponentTargetMessageArguments. More...
 
enum  State { StateDetached, StateDetaching, StateAttaching, StateAttached }
 State indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...
 
- 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
 
- Static Public Attributes inherited from kanzi::DataTriggerComponent
static PropertyType< string > ConditionExpressionProperty
 The Binding expression that defines the condition for this DataTrigger. More...
 
- Static Public Attributes inherited from kanzi::NodeComponent
static PropertyType< string > NameProperty
 Name property specifies the name of node component. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType >
static void nodeComponentMessageHandler (const NodeComponent *nodeComponent, const typename TMessageType::FunctionType &function, typename TMessageType::ArgumentsType &messageArguments)
 Handler function for node component messages. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Use a DataTrigger to apply an action to either set a property value of a target node or activate an Activity node.

A DataTrigger keeps that action applied for as long as the condition in that DataTrigger is met. When the condition in that DataTrigger is no longer met, Kanzi reverts the changes that it applied using that DataTrigger. Note that in a DataTrigger you can use only ApplyAction actions: ApplyActivationAction and ApplyPropertyAction.

You set the condition in a DataTrigger in the form of a binding expression that evaluates to either true or false. In the condition you can use as an input either a property or a data source.

For example, you can use a DataTrigger to control the logic and activation state of Activity nodes in Activity Host nodes using ApplyAction actions.

ApplyAction actions of a DataTrigger have higher priority than the actions of any other Trigger. For example, if you use a DataTrigger with an ApplyPropertyAction that sets the DataDrivenExclusiveActivityHostConcept::ActiveActivityIndexProperty to some value and any other Trigger with a SetPropertyAction that sets that same property to a different value, the effect of the SetPropertyAction becomes visible only after Kanzi unapplies the ApplyPropertyAction.

Examples

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

// 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);

To use a DataTrigger to set the value of a property with an ApplyPropertyAction when a condition in a DataTrigger is met:

// Create an instance of an Apply Property action.
auto action = ApplyPropertyAction::create(domain, "applyAction");
// Set the path of the target node to which you want to add the Apply Property action.
action->setProperty(ApplyPropertyAction::TargetObjectPathProperty, "targetNode");
// Create a binding to configure how you want to set a property of the target node.
action->addValueBinding(Variant(targetPropertyTargetValue), MyPropertyB, PropertyField::PropertyFieldWhole);
// Create a condition expression for the Data Trigger.
// Condition: sourceNode.MyPropertyA == m_sourcePropertyTriggeringValue.
valueSources.push_back(ObjectPropertyExpressionValueSource::create("sourceNode", 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);
// Create a Data Trigger, add the condition and the Apply Property action that you created earlier, and add the trigger to the Screen node.
auto dataTrigger = DataTrigger::create(domain, "data trigger");
dataTrigger->setConditionExpression(binding);
dataTrigger->addAction(action);
screen->addNodeComponent(dataTrigger);
screen->attach();
// Since the condition of the Data Trigger is not met, the property of the target node does not change.
sourceNode->setProperty(MyPropertyA, m_sourcePropertySomeOtherValue1);
assertEquals(targetPropertyDefaultValue, targetNode->getProperty(MyPropertyB));
// Set the property of the source node to meet the condition. When the condition is met,
// the trigger sets off the Apply Property action, and the action updates the property in the target node.
sourceNode->setProperty(MyPropertyA, m_sourcePropertyTriggeringValue);
assertEquals(targetPropertyTargetValue, targetNode->getProperty(MyPropertyB));
// As soon as the condition of the Data Trigger is not met,
// Kanzi rolls back the property in the target node to the value before the Apply Property action was applied.
sourceNode->setProperty(MyPropertyA, m_sourcePropertySomeOtherValue2);
assertEquals(targetPropertyDefaultValue, targetNode->getProperty(MyPropertyB));

Constructor & Destructor Documentation

kanzi::DataTrigger::~DataTrigger ( )
override

Destructor.

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

Constructor.

Parameters
domainThe UI domain the new trigger belongs to.
nameThe name of the trigger.

Member Function Documentation

static auto kanzi::DataTrigger::create ( Domain domain,
string_view  name 
)
inlinestatic

Constructor.

Parameters
domainThe UI domain the new trigger belongs to.
nameThe name of the trigger.
static kanzi::PropertyTypeEditorInfoSharedPtr kanzi::DataTrigger::makeEditorInfo ( )
static
void kanzi::DataTrigger::forceApplyActions ( )

Applies the Actions in a DataTrigger, regardless of the ConditionExpression in that DataTrigger.

See also
revokeForceApplyActions()
void kanzi::DataTrigger::revokeForceApplyActions ( )

Sets a DataTrigger to apply its Actions only when the ConditionExpression in that DataTrigger evaluates to True.

See also
forceApplyActions()
bool kanzi::DataTrigger::areActionsForced ( ) const

Returns whether a DataTrigger applies its Actions regardless of the ConditionExpression in that DataTrigger.

Returns
If the DataTrigger Actions are always applied, returns true. If the DataTrigger evaluates ConditionExpression to apply Actions, returns false.
void kanzi::DataTrigger::applyActions ( )
protected

Applies the ApplyAction actions associated with this Data Trigger.

See also
ForwardingApplyAction, ApplyActivationAction.
void kanzi::DataTrigger::unapplyActions ( )
protected

Unapplies the ApplyAction actions associated with this Data Trigger.

This method restores the state of the target to its previous value, that is, to the value before applying the actions.

See also
ForwardingApplyAction, ApplyActivationAction.
void kanzi::DataTrigger::attachOverride ( )
overrideprotectedvirtual

NodeComponent::attachOverride implementation.

Reimplemented from kanzi::DataTriggerComponent.

void kanzi::DataTrigger::detachOverride ( )
overrideprotectedvirtual

NodeComponent::detachOverride implementation.

Reimplemented from kanzi::DataTriggerComponent.


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