Kanzi  3.9.7
Kanzi Engine API
kanzi::ForwardingAction Class Reference

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, BindingEntryBindingContainer
 
typedef BindingRuntimeContainer::const_iterator BindingRuntimeConstIterator
 
typedef map< AbstractPropertyType, BindingRuntimeEntryBindingRuntimeContainer
 
- 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
 

Public Member Functions

ManualBindingRuntimeSharedPtr addArgumentBinding (AbstractPropertyType sourceArgument, AbstractPropertyType targetArgument)
 Adds a binding from message argument to a node or a message argument. More...
 
ManualBindingRuntimeSharedPtr addArgumentBinding (AbstractPropertyType sourceArgument, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
 Adds a binding from message argument to a node or a message argument. More...
 
ManualBindingRuntimeSharedPtr addBinding (string_view targetPath, AbstractPropertyType targetArgument, PropertyField targetField, ManualBindingSharedPtr binding)
 Adds an arbitrary binding object to an action. More...
 
ManualBindingRuntimeSharedPtr addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, AbstractPropertyType targetArgument)
 Adds a binding from property to a node or a message argument. More...
 
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. More...
 
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. More...
 
ManualBindingRuntimeSharedPtr addPropertyBinding (AbstractPropertyType sourcePropertyType, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
 Adds a binding from property to a node or a message argument. More...
 
void addResourceBinding (ResourceID id, AbstractPropertyType targetArgument, PropertyField targetField)
 Adds a binding from resource ID to a property field. More...
 
void addResourceBinding (ResourceID id, AbstractPropertyType targetArgument)
 Adds a binding from resource ID to a property. More...
 
void addResourceBinding (string_view id, AbstractPropertyType targetArgument, PropertyField targetField)
 Adds a binding from resource ID to a property field. More...
 
void addResourceBinding (string_view id, AbstractPropertyType targetArgument)
 Adds a binding from resource ID to an object property. More...
 
ManualBindingRuntimeSharedPtr addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument, PropertyField targetField)
 Adds a binding from a value to a node or a message argument. More...
 
ManualBindingRuntimeSharedPtr addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument)
 Adds a binding from value to a node or a message argument. More...
 
BindingRuntimeConstIterator beginBindingRuntimes () const
 Returns a const iterator pointing to the first binding runtimes. More...
 
BindingConstIterator beginBindings () const
 Returns a const iterator pointing to the first bindings. More...
 
BindingRuntimeConstIterator endBindingRuntimes () const
 Returns a const iterator pointing to the end of binding runtimes. More...
 
BindingConstIterator endBindings () const
 Returns a const iterator pointing to the end of bindings. More...
 
- Public Member Functions inherited from kanzi::Action
void attach (Trigger *trigger)
 Attaches an Action to a Trigger. More...
 
ActionSharedPtr copy () const
 
void detach ()
 Detaches the Action from the Trigger. More...
 
TriggergetTrigger () const
 Returns the pointer to a Trigger to which an Action is attached. More...
 
void invoke ()
 Invokes the Action. More...
 
chrono::milliseconds getDelay () const
 Returns the delay in milliseconds that Kanzi waits before it invokes an action. More...
 
void setDelay (chrono::milliseconds delay)
 Sets the delay in milliseconds that Kanzi waits before it invokes an action. 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 ()
 

Protected Member Functions

void applyResourceBindings (string_view path)
 Sets all resource bindings to their respective target items, if possible. More...
 
void attachMessageToSourceRuntimes ()
 Updates a message on message binding source runtimes. More...
 
void attachTriggerToLookUpContexts ()
 Updates triggers on binding trigger look-up contexts. More...
 
virtual BindingTargetRuntimePtr createTriggerBindingTargetRuntime (string_view targetPath, AbstractPropertyType targetArgument, PropertyField targetField)
 Creates a binding target for a manual binding. More...
 
 ForwardingAction (Domain *domain, string_view name)
 Constructor. More...
 
Variant getArgument (AbstractPropertyType argumentType)
 Gets the value of the argument with given property type in the forwarded message of associated trigger. More...
 
void load (KzbFile &kzbFile, KzbMemoryParser &parser) override
 Action::load() implementation. More...
 
void loadBinding (KzbFile &kzbFile, KzbMemoryParser &parser)
 Loads a binding object from a kzb file. More...
 
void onAttach () override
 Action::onAttach() implementation. More...
 
void onCopy (const ForwardingAction &other)
 Must be called by deriving classes on new instances created inside implementations of clone(). More...
 
void onInvoke () override
 Action::onInvoke() implementation. More...
 
void onPrepareDelayedInvoke () override
 Action::onPrepareDelayedInvoke() implementation. More...
 
void removeAllBindings ()
 Removes all binding objects from an action. More...
 
void removeBinding (AbstractPropertyType argumentType)
 Removes a binding object from an action. More...
 
void removeBinding (AbstractBindingRuntimeSharedPtr bindingRuntime)
 Removes a binding object from an action. More...
 
- Protected Member Functions inherited from kanzi::Action
 Action (Domain *domain, string_view name)
 Constructor. More...
 
virtual ActionSharedPtr clone () const =0
 Overridable function for copying an Action. More...
 
virtual void onDelayedInvoke ()
 Callback called by Kanzi when the action is invoked by trigger with delay, after the delay duration expires. More...
 
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. More...
 
- Protected Member Functions inherited from kanzi::ActionBase
 ActionBase (Domain *domain, string_view name)
 Constructor. 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...
 

Protected Attributes

BindingRuntimeContainer m_bindingRuntimes
 Runtimes for binding rules to execute on invoke. More...
 
BindingContainer m_resourceBindings
 Resource bindings to set to target object on invoke. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kanzi::Action
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Provides the Kanzi Studio editor metadata for the SetPropertyAction. 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 inherited from kanzi::Action
static PropertyType< int > DelayProperty
 Delays all invocations of an action by the amount in milliseconds. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 

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
{
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.
}
// Implement delayed callbacks accordingly.

Member Typedef Documentation

typedef BindingRuntimeContainer::const_iterator kanzi::ForwardingAction::BindingRuntimeConstIterator
typedef BindingContainer::const_iterator kanzi::ForwardingAction::BindingConstIterator

Constructor & Destructor Documentation

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

Constructor.

Parameters
domainDomain to use.
nameName of the forwarding action.

Member Function Documentation

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
sourceValueSource value.
targetArgumentTarget argument property type for the forwarded value.
targetFieldTarget field of the argument property type.
Returns
Binding runtime for created binding.
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
sourceValueSource value.
targetArgumentTarget argument property type for the forwarded value.
Returns
Binding runtime for created binding.
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
sourceArgumentSource message argument.
targetArgumentTarget argument property type for the forwarded value.
Returns
Binding runtime for created binding.
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
sourceArgumentSource message argument.
sourceFieldSource field of the argument property type.
targetArgumentTarget argument property type for the forwarded value.
targetFieldTarget field of the argument property type.
Returns
Binding runtime for created binding.
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
sourceObjectPathPath to source object.
sourcePropertyTypeSource property.
targetArgumentTarget argument property type for the forwarded value.
Returns
Binding runtime for created binding.
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
sourceObjectPathPath to source object.
sourcePropertyTypeSource property.
sourceFieldSource field of the argument property type.
targetObjectPathPath to target object.
targetArgumentTarget argument property type for the forwarded value.
targetFieldTarget field of the argument property type.
Returns
Binding runtime for created binding.
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
sourceObjectPathPath to source object.
sourcePropertyTypeSource property.
sourceFieldSource field of the argument property type.
targetArgumentTarget argument property type for the forwarded value.
targetFieldTarget field of the argument property type.
Returns
Binding runtime for created binding.
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
sourcePropertyTypeSource property.
sourceFieldSource field of the argument property type.
targetArgumentTarget argument property type for the forwarded value.
targetFieldTarget field of the argument property type.
Returns
Binding runtime for created binding.
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
idResource ID.
targetArgumentTarget argument property type for the forwarded value.
targetFieldTarget field of the argument property type.
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
idResource ID.
targetArgumentTarget argument property type for the forwarded value.
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
idResource ID.
targetArgumentTarget argument property type for the forwarded value.
targetFieldTarget field of the argument property type.
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
idResource ID.
targetArgumentTarget argument property type for the forwarded value.
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
targetPathTarget path.
targetArgumentTarget property.
targetFieldTarget property field.
bindingBinding object to add.
Returns
ManualBindingRuntimeSharedPtr created from the binding.
See also
removeBinding, removeAllBindings
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.
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.
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.
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.
void kanzi::ForwardingAction::load ( KzbFile kzbFile,
KzbMemoryParser parser 
)
overrideprotectedvirtual

Action::load() implementation.

Reimplemented from kanzi::ActionBase.

Reimplemented in kanzi::SetPropertyAction.

void kanzi::ForwardingAction::onAttach ( )
overrideprotectedvirtual

Action::onAttach() implementation.

Reimplemented from kanzi::ActionBase.

void kanzi::ForwardingAction::onInvoke ( )
overrideprotectedvirtual

Action::onInvoke() implementation.

Reimplemented from kanzi::Action.

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

void kanzi::ForwardingAction::onPrepareDelayedInvoke ( )
overrideprotectedvirtual

Action::onPrepareDelayedInvoke() implementation.

Reimplemented from kanzi::Action.

Reimplemented in kanzi::SetPropertyAction.

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

Loads a binding object from a kzb file.

Parameters
kzbFileInput file.
parserKZB file parser to use.
virtual BindingTargetRuntimePtr kanzi::ForwardingAction::createTriggerBindingTargetRuntime ( string_view  targetPath,
AbstractPropertyType  targetArgument,
PropertyField  targetField 
)
protectedvirtual

Creates a binding target for a manual binding.

Parameters
targetPathTarget path.
targetArgumentTarget property.
targetFieldTarget property field.
Returns
The binding target that you can use with the manual binding target.

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

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

Removes a binding object from an action.

Parameters
argumentTypeThe type of argument to remove.
See also
addBinding
void kanzi::ForwardingAction::removeBinding ( AbstractBindingRuntimeSharedPtr  bindingRuntime)
protected

Removes a binding object from an action.

Parameters
bindingRuntimeThe binding runtime to remove.
See also
addBinding
void kanzi::ForwardingAction::removeAllBindings ( )
protected

Removes all binding objects from an action.

See also
addBinding
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()
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
argumentTypeProperty type of the argument.
Returns
Variant holding the value of the argument.
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
pathPath to target item, Node or RenderPass.
void kanzi::ForwardingAction::attachTriggerToLookUpContexts ( )
protected

Updates triggers on binding trigger look-up contexts.

void kanzi::ForwardingAction::attachMessageToSourceRuntimes ( )
protected

Updates a message on message binding source runtimes.

Member Data Documentation

BindingRuntimeContainer kanzi::ForwardingAction::m_bindingRuntimes
protected

Runtimes for binding rules to execute on invoke.

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: