ForwardingAction is the base class for the action classes that read and send arguments, such as SetPropertyAction or DispatchMessageAction. More...

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

Inheritance diagram for kanzi::ForwardingAction:

[legend]

Classes
struct	BindingEntry
	Entry for bindings to install when the action is invoked. More...

struct	BindingRuntimeEntry
	Entry for binding runtimes to execute when the action is invoked. More...

Public Types
typedef BindingContainer::const_iterator	BindingConstIterator

typedef map< AbstractPropertyType, BindingEntry >	BindingContainer

typedef BindingRuntimeContainer::const_iterator	BindingRuntimeConstIterator

typedef map< AbstractPropertyType, BindingRuntimeEntry >	BindingRuntimeContainer

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
ManualBindingRuntimeSharedPtr	addArgumentBinding (AbstractPropertyType sourceArgument, AbstractPropertyType targetArgument)
	Adds a binding from message argument to a node or a message argument.

ManualBindingRuntimeSharedPtr	addArgumentBinding (AbstractPropertyType sourceArgument, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from message argument to a node or a message argument.

ManualBindingRuntimeSharedPtr	addBinding (string_view targetPath, AbstractPropertyType targetArgument, PropertyField targetField, ManualBindingSharedPtr binding)
	Adds an arbitrary binding object to an action.

ManualBindingRuntimeSharedPtr	addPropertyBinding (AbstractPropertyType sourcePropertyType, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from property to a node or a message argument.

ManualBindingRuntimeSharedPtr	addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, AbstractPropertyType targetArgument)
	Adds a binding from property to a node or a message argument.

ManualBindingRuntimeSharedPtr	addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from property to a node or a message argument.

ManualBindingRuntimeSharedPtr	addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField, string_view targetObjectPath, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from property to a node or a message argument.

void	addResourceBinding (ResourceID id, AbstractPropertyType targetArgument)
	Adds a binding from resource ID to a property.

void	addResourceBinding (ResourceID id, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from resource ID to a property field.

void	addResourceBinding (string_view id, AbstractPropertyType targetArgument)
	Adds a binding from resource ID to an object property.

void	addResourceBinding (string_view id, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from resource ID to a property field.

ManualBindingRuntimeSharedPtr	addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument)
	Adds a binding from value to a node or a message argument.

ManualBindingRuntimeSharedPtr	addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from a value to a node or a message argument.

BindingRuntimeConstIterator	beginBindingRuntimes () const
	Returns a const iterator pointing to the first binding runtimes.

BindingConstIterator	beginBindings () const
	Returns a const iterator pointing to the first bindings.

BindingRuntimeConstIterator	endBindingRuntimes () const
	Returns a const iterator pointing to the end of binding runtimes.

BindingConstIterator	endBindings () const
	Returns a const iterator pointing to the end of bindings.

Public Member Functions inherited from kanzi::Action
void	attach (Trigger *trigger)
	Attaches an Action to a Trigger.

ActionSharedPtr	copy () const

void	detach ()
	Detaches the Action from the Trigger.

Trigger *	getTrigger () const
	Returns the pointer to a Trigger to which an Action is attached.

void	invoke ()
	Invokes the Action.

chrono::milliseconds	getDelay () const
	Returns the delay in milliseconds that Kanzi waits before it invokes an action.

void	setDelay (chrono::milliseconds delay)
	Sets the delay in milliseconds that Kanzi waits before it invokes an action.

Public Member Functions inherited from kanzi::ActionBase
string	getName () const
	Returns the name of the action.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~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.

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.

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, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

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.

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.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

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.

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.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Protected Member Functions
void	applyResourceBindings (string_view path)
	Sets all resource bindings to their respective target items, if possible.

void	attachMessageToSourceRuntimes ()
	Updates a message on message binding source runtimes.

void	attachTriggerToLookUpContexts ()
	Updates triggers on binding trigger look-up contexts.

virtual BindingTargetRuntimePtr	createTriggerBindingTargetRuntime (string_view targetPath, AbstractPropertyType targetArgument, PropertyField targetField)
	Creates a binding target for a manual binding.

	ForwardingAction (Domain *domain, string_view name)
	Constructor.

Variant	getArgument (AbstractPropertyType argumentType)
	Gets the value of the argument with given property type in the forwarded message of associated trigger.

void	load (KzbFile &kzbFile, KzbMemoryParser &parser) override
	Action::load() implementation.

void	loadBinding (KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads a binding object from a kzb file.

void	onAttach () override
	Action::onAttach() implementation.

void	onCopy (const ForwardingAction &other)
	Must be called by deriving classes on new instances created inside implementations of clone().

void	onInvoke () override
	Action::onInvoke() implementation.

void	onPrepareDelayedInvoke () override
	Action::onPrepareDelayedInvoke() implementation.

void	removeAllBindings ()
	Removes all binding objects from an action.

void	removeBinding (AbstractBindingRuntimeSharedPtr bindingRuntime)
	Removes a binding object from an action.

void	removeBinding (AbstractPropertyType argumentType)
	Removes a binding object from an action.

Protected Member Functions inherited from kanzi::Action
	Action (Domain *domain, string_view name)
	Constructor.

virtual ActionSharedPtr	clone () const =0
	Overridable function for copying an Action.

virtual void	onDelayedInvoke ()
	Callback called by Kanzi when the action is invoked by trigger with delay, after the delay duration expires.

virtual void	onUnprepareDelayedInvoke ()
	Kanzi calls this callback when an action is invoked by trigger with delay, after onDelayedInvoke() callback, or when it cancels a delayed execution.

Protected Member Functions inherited from kanzi::ActionBase
	ActionBase (Domain *domain, string_view name)
	Constructor.

virtual void	onDetach ()
	Overridable method called during detach.

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::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (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.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Protected Attributes
BindingRuntimeContainer	m_bindingRuntimes
	Runtimes for binding rules to execute on invoke.

BindingContainer	m_resourceBindings
	Resource bindings to set to target object on invoke.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Additional Inherited Members
Static Public Member Functions inherited from kanzi::Action
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Provides the Kanzi Studio editor metadata for the SetPropertyAction.

Static Public Member Functions inherited from kanzi::ActionBase
static ActionBaseSharedPtr	loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads an ActionBase from a kzb file.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Provides the Kanzi Studio editor metadata for the ActionBase.

template<typename TAction >
static shared_ptr< TAction >	loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads an TAction from a kzb file.

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Attributes inherited from kanzi::Action
static PropertyType< int >	DelayProperty
	Delays all invocations of an action by the amount in milliseconds.

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Detailed Description

ForwardingAction is the base class for the action classes that read and send arguments, such as SetPropertyAction or DispatchMessageAction.

ForwardingAction contains functionality to read arguments from sources, such as messages, properties or set values, and allows the inheriting action class to use these values. This usually means sending messages or setting values of properties.

Examples

To derive an action class from the ForwardingAction class:

 
    // A sample action class derived from ForwardingAction.
    // Reads:
    // * A fixed value.
    // * MyPropertyB of the triggering message.
    // * MyPropertyC of the trigger host node.
    // * A resource alias MyResource.
    // Writes the values to these properties of the parent of the trigger host node respectively:
    // * MyPropertyA
    // * MyPropertyB
    // * MyPropertyC
    // * MyPropertyD
    class MyForwardingAction : public ForwardingAction
    {
    public:
        // Constructor.
        explicit MyForwardingAction(Domain* domain, string_view name) :
            ForwardingAction(domain, name)
        {
            // Create the bindings.
 
            addValueBinding(Variant(1), MyPropertyA);
 
            addArgumentBinding(MyPropertyB, MyPropertyB);
 
            addPropertyBinding(".", MyPropertyC, MyPropertyC);
 
            addResourceBinding("MyResource", MyPropertyD);
        }
 
    protected:
        // Implement createTriggerBindingTargetRuntime() override.
        // ForwardingAction calls for creation of each target binding runtime.
        BindingTargetRuntimePtr createTriggerBindingTargetRuntime(string_view /*targetPath*/, AbstractPropertyType targetArgument, PropertyField targetField) override
        {
            // Set the target path to relative path to the parent node.
            return ForwardingAction::createTriggerBindingTargetRuntime("../", targetArgument, targetField);
        }
 
        // In onInvoke() override, implement the behavior of the action when Kanzi executes it without delay.
        void onInvoke() override
        {
            ForwardingAction::onInvoke();
 
            for (auto& bindingRuntimeEntryPair : m_bindingRuntimes)
            {
                auto& bindingRuntime = bindingRuntimeEntryPair.second.bindingRuntime;
 
                // Read and write all binding runtimes.
                if (bindingRuntime->read())
                {
                    bindingRuntime->write();
                }
            }
 
            // Apply all resource bindings to the parent node.
            applyResourceBindings("../");
        }
 
        // Implement delayed callbacks accordingly.

Member Typedef Documentation

◆ BindingRuntimeContainer

typedef map<AbstractPropertyType, BindingRuntimeEntry> kanzi::ForwardingAction::BindingRuntimeContainer

◆ BindingRuntimeConstIterator

typedef BindingRuntimeContainer::const_iterator kanzi::ForwardingAction::BindingRuntimeConstIterator

◆ BindingContainer

typedef map<AbstractPropertyType, BindingEntry> kanzi::ForwardingAction::BindingContainer

◆ BindingConstIterator

typedef BindingContainer::const_iterator kanzi::ForwardingAction::BindingConstIterator

Constructor & Destructor Documentation

◆ ForwardingAction()

kanzi::ForwardingAction::ForwardingAction	(	Domain *	domain,
		string_view	name )

explicitprotected

Constructor.

Parameters

domain	Domain to use.
name	Name of the forwarding action.

Member Function Documentation

◆ addValueBinding() [1/2]

ManualBindingRuntimeSharedPtr kanzi::ForwardingAction::addValueBinding	(	const Variant &	sourceValue,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField )

Adds a binding from a value to a node or a message argument.

Use this function to set constant values to sent messages. Note that successive actions can override these values.

Parameters

sourceValue	Source value.
targetArgument	Target argument property type for the forwarded value.
targetField	Target field of the argument property type.

Returns: Binding runtime for created binding.

◆ addValueBinding() [2/2]

ManualBindingRuntimeSharedPtr kanzi::ForwardingAction::addValueBinding	(	const Variant &	sourceValue,
		AbstractPropertyType	targetArgument )

inline

Adds a binding from value to a node or a message argument.

Use this function to bind from source values to message arguments. Target property field is PropertyFieldWhole.

Parameters

sourceValue	Source value.
targetArgument	Target argument property type for the forwarded value.

Returns: Binding runtime for created binding.

◆ addArgumentBinding() [1/2]

ManualBindingRuntimeSharedPtr kanzi::ForwardingAction::addArgumentBinding	(	AbstractPropertyType	sourceArgument,
		AbstractPropertyType	targetArgument )

Adds a binding from message argument to a node or a message argument.

Use this function to bind from source message arguments to target message arguments. Both source and target property fields are PropertyFieldWhole.

Parameters

sourceArgument	Source message argument.
targetArgument	Target argument property type for the forwarded value.

Returns: Binding runtime for created binding.

◆ addArgumentBinding() [2/2]

ManualBindingRuntimeSharedPtr kanzi::ForwardingAction::addArgumentBinding	(	AbstractPropertyType	sourceArgument,
		PropertyField	sourceField,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField )

Adds a binding from message argument to a node or a message argument.

Use this function to bind from source message arguments to target message arguments. Source property field is PropertyFieldWhole.

Parameters

sourceArgument	Source message argument.
sourceField	Source field of the argument property type.
targetArgument	Target argument property type for the forwarded value.
targetField	Target field of the argument property type.

Returns: Binding runtime for created binding.

◆ addPropertyBinding() [1/4]

ManualBindingRuntimeSharedPtr kanzi::ForwardingAction::addPropertyBinding	(	string_view	sourceObjectPath,
		AbstractPropertyType	sourcePropertyType,
		AbstractPropertyType	targetArgument )

Adds a binding from property to a node or a message argument.

Use this function to bind from source object properties to target message arguments. Target property field is PropertyFieldWhole.

Parameters

sourceObjectPath	Path to source object.
sourcePropertyType	Source property.
targetArgument	Target argument property type for the forwarded value.

Returns: Binding runtime for created binding.

◆ addPropertyBinding() [2/4]

ManualBindingRuntimeSharedPtr kanzi::ForwardingAction::addPropertyBinding	(	string_view	sourceObjectPath,
		AbstractPropertyType	sourcePropertyType,
		PropertyField	sourceField,
		string_view	targetObjectPath,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField )

Adds a binding from property to a node or a message argument.

Use this function to bind from source object properties to target object properties.

Parameters

sourceObjectPath	Path to source object.
sourcePropertyType	Source property.
sourceField	Source field of the argument property type.
targetObjectPath	Path to target object.
targetArgument	Target argument property type for the forwarded value.
targetField	Target field of the argument property type.

Returns: Binding runtime for created binding.

◆ addPropertyBinding() [3/4]

ManualBindingRuntimeSharedPtr kanzi::ForwardingAction::addPropertyBinding	(	string_view	sourceObjectPath,
		AbstractPropertyType	sourcePropertyType,
		PropertyField	sourceField,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField )

Adds a binding from property to a node or a message argument.

Use this function to bind from source object properties to target object properties. Target object path is ".".

Parameters

sourceObjectPath	Path to source object.
sourcePropertyType	Source property.
sourceField	Source field of the argument property type.
targetArgument	Target argument property type for the forwarded value.
targetField	Target field of the argument property type.

Returns: Binding runtime for created binding.

◆ addPropertyBinding() [4/4]

ManualBindingRuntimeSharedPtr kanzi::ForwardingAction::addPropertyBinding	(	AbstractPropertyType	sourcePropertyType,
		PropertyField	sourceField,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField )

inline

Adds a binding from property to a node or a message argument.

Use this function to bind from source object properties to target object properties. Source and target object paths are ".".

Parameters

sourcePropertyType	Source property.
sourceField	Source field of the argument property type.
targetArgument	Target argument property type for the forwarded value.
targetField	Target field of the argument property type.

Returns: Binding runtime for created binding.

◆ addResourceBinding() [1/4]

void kanzi::ForwardingAction::addResourceBinding	(	ResourceID	id,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField )

Adds a binding from resource ID to a property field.

Use this function to bind resolve resources to target message arguments.

Parameters

id	Resource ID.
targetArgument	Target argument property type for the forwarded value.
targetField	Target field of the argument property type.

◆ addResourceBinding() [2/4]

void kanzi::ForwardingAction::addResourceBinding	(	ResourceID	id,
		AbstractPropertyType	targetArgument )

inline

Adds a binding from resource ID to a property.

Use this function to bind resolve resources to target message arguments.

Parameters

id	Resource ID.
targetArgument	Target argument property type for the forwarded value.

◆ addResourceBinding() [3/4]

void kanzi::ForwardingAction::addResourceBinding	(	string_view	id,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField )

inline

Adds a binding from resource ID to a property field.

Use this function to bind resolve resources to target message arguments.

Parameters

id	Resource ID.
targetArgument	Target argument property type for the forwarded value.
targetField	Target field of the argument property type.

◆ addResourceBinding() [4/4]

void kanzi::ForwardingAction::addResourceBinding	(	string_view	id,
		AbstractPropertyType	targetArgument )

inline

Adds a binding from resource ID to an object property.

Use this function to bind resolve resources to target message arguments.

Parameters

id	Resource ID.
targetArgument	Target argument property type for the forwarded value.

◆ addBinding()

ManualBindingRuntimeSharedPtr kanzi::ForwardingAction::addBinding	(	string_view	targetPath,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField,
		ManualBindingSharedPtr	binding )

Adds an arbitrary binding object to an action.

An action can be executed in multiple parts where it can be first read and then written. For this reason, you can only add manual bindings or binding types that support delayed execution.

Parameters

targetPath	Target path.
targetArgument	Target property.
targetField	Target property field.
binding	Binding object to add.

Returns: ManualBindingRuntimeSharedPtr created from the binding.

See also: removeBinding, removeAllBindings

◆ beginBindingRuntimes()

BindingRuntimeConstIterator kanzi::ForwardingAction::beginBindingRuntimes ( ) const

inline

Returns a const iterator pointing to the first binding runtimes.

Returns: Const iterator pointing at the first element in the container.

◆ endBindingRuntimes()

BindingRuntimeConstIterator kanzi::ForwardingAction::endBindingRuntimes ( ) const

inline

Returns a const iterator pointing to the end of binding runtimes.

Returns: Const iterator pointing at the end of the container.

◆ beginBindings()

BindingConstIterator kanzi::ForwardingAction::beginBindings ( ) const

inline

Returns a const iterator pointing to the first bindings.

Returns: Const iterator pointing at the first element in the container.

◆ endBindings()

BindingConstIterator kanzi::ForwardingAction::endBindings ( ) const

inline

Returns a const iterator pointing to the end of bindings.

Returns: Const iterator pointing at the end of the container.

◆ load()

void kanzi::ForwardingAction::load	(	KzbFile &	kzbFile,
		KzbMemoryParser &	parser )

overrideprotectedvirtual

Action::load() implementation.

Reimplemented from kanzi::ActionBase.

Reimplemented in kanzi::SetPropertyAction.

◆ onAttach()

void kanzi::ForwardingAction::onAttach ( )

overrideprotectedvirtual

Action::onAttach() implementation.

Reimplemented from kanzi::ActionBase.

◆ onInvoke()

void kanzi::ForwardingAction::onInvoke ( )

overrideprotectedvirtual

Action::onInvoke() implementation.

Reimplemented from kanzi::Action.

Reimplemented in kanzi::SetPropertyAction, and kanzi::WriteLogAction.

◆ onPrepareDelayedInvoke()

void kanzi::ForwardingAction::onPrepareDelayedInvoke ( )

overrideprotectedvirtual

Action::onPrepareDelayedInvoke() implementation.

Reimplemented from kanzi::Action.

Reimplemented in kanzi::SetPropertyAction.

◆ loadBinding()

void kanzi::ForwardingAction::loadBinding	(	KzbFile &	kzbFile,
		KzbMemoryParser &	parser )

protected

Loads a binding object from a kzb file.

Parameters

kzbFile	Input file.
parser	KZB file parser to use.

◆ createTriggerBindingTargetRuntime()

virtual BindingTargetRuntimePtr kanzi::ForwardingAction::createTriggerBindingTargetRuntime	(	string_view	targetPath,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField )

protectedvirtual

Creates a binding target for a manual binding.

Parameters

targetPath	Target path.
targetArgument	Target property.
targetField	Target property field.

Returns: The binding target that you can use with the manual binding target.

Reimplemented in kanzi::DispatchMessageAction, and kanzi::SetPropertyAction.

◆ removeBinding() [1/2]

void kanzi::ForwardingAction::removeBinding ( AbstractPropertyType argumentType )

protected

Removes a binding object from an action.

Parameters

argumentType The type of argument to remove.

See also: addBinding

◆ removeBinding() [2/2]

void kanzi::ForwardingAction::removeBinding ( AbstractBindingRuntimeSharedPtr bindingRuntime )

protected

Removes a binding object from an action.

Parameters

bindingRuntime The binding runtime to remove.

See also: addBinding

◆ removeAllBindings()

void kanzi::ForwardingAction::removeAllBindings ( )

protected

Removes all binding objects from an action.

See also: addBinding

◆ onCopy()

void kanzi::ForwardingAction::onCopy ( const ForwardingAction & other )

protected

Must be called by deriving classes on new instances created inside implementations of clone().

See also: Action::clone()

◆ getArgument()

Variant kanzi::ForwardingAction::getArgument ( AbstractPropertyType argumentType )

protected

Gets the value of the argument with given property type in the forwarded message of associated trigger.

For use inside onInvoke() overrides.

Parameters

argumentType Property type of the argument.

Returns: Variant holding the value of the argument.

◆ applyResourceBindings()

void kanzi::ForwardingAction::applyResourceBindings ( string_view path )

protected

Sets all resource bindings to their respective target items, if possible.

For use inside onInvoke() overrides.

Parameters

path	Path to target item, Node or RenderPass.

◆ attachTriggerToLookUpContexts()

void kanzi::ForwardingAction::attachTriggerToLookUpContexts ( )

protected

Updates triggers on binding trigger look-up contexts.

◆ attachMessageToSourceRuntimes()

void kanzi::ForwardingAction::attachMessageToSourceRuntimes ( )

protected

Updates a message on message binding source runtimes.

Member Data Documentation

◆ m_bindingRuntimes

BindingRuntimeContainer kanzi::ForwardingAction::m_bindingRuntimes

protected

Runtimes for binding rules to execute on invoke.

◆ m_resourceBindings

BindingContainer kanzi::ForwardingAction::m_resourceBindings

protected

Resource bindings to set to target object on invoke.

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

kanzi/ui/action/forwarding_action.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Examples

Member Typedef Documentation

◆ BindingRuntimeContainer

◆ BindingRuntimeConstIterator

◆ BindingContainer

◆ BindingConstIterator

Constructor & Destructor Documentation

◆ ForwardingAction()

Member Function Documentation

◆ addValueBinding() [1/2]

◆ addValueBinding() [2/2]

◆ addArgumentBinding() [1/2]

◆ addArgumentBinding() [2/2]

◆ addPropertyBinding() [1/4]

◆ addPropertyBinding() [2/4]

◆ addPropertyBinding() [3/4]

◆ addPropertyBinding() [4/4]

◆ addResourceBinding() [1/4]

◆ addResourceBinding() [2/4]

◆ addResourceBinding() [3/4]

◆ addResourceBinding() [4/4]

◆ addBinding()

◆ beginBindingRuntimes()

◆ endBindingRuntimes()

◆ beginBindings()

◆ endBindings()

◆ load()

◆ onAttach()

◆ onInvoke()

◆ onPrepareDelayedInvoke()

◆ loadBinding()

◆ createTriggerBindingTargetRuntime()

◆ removeBinding() [1/2]

◆ removeBinding() [2/2]

◆ removeAllBindings()

◆ onCopy()

◆ getArgument()

◆ applyResourceBindings()

◆ attachTriggerToLookUpContexts()

◆ attachMessageToSourceRuntimes()

Member Data Documentation

◆ m_bindingRuntimes

◆ m_resourceBindings