Kanzi 3.9.10
kanzi::ExecuteLuaAction Class Reference

You can use ExecuteLuaAction to run a Lua script that implements application logic. More...

#include <kanzi/lua/execute_lua_action.hpp>

Inheritance diagram for kanzi::ExecuteLuaAction:
[legend]

Static Public Member Functions

static ExecuteLuaActionSharedPtr create (Domain *domain, string_view name)
 Creates an ExecuteLuaAction.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Provides the editor info.
 
- 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< TActionloadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
 Loads an TAction from a kzb file.
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 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 MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info.
 

Static Public Attributes

static PropertyType< string > ScriptUrlProperty
 Holds the url of the Lua script.
 
- Static Public Attributes inherited from kanzi::Action
static PropertyType< intDelayProperty
 Delays all invocations of an action by the amount in milliseconds.
 

Protected Member Functions

ActionSharedPtr clone () const override
 Action::clone() implementation.
 
 ExecuteLuaAction (Domain *domain, string_view name)
 Constructor.
 
BinaryResourceSharedPtr getLuaScriptResource () const
 Returns the resource ScriptUrlProperty points to.
 
bool loadScript (BinaryResource &resource)
 Loads the resource script into Lua.
 
virtual void onAttach () override
 ActionBase::onAttach() implementation.
 
void onDelayedInvoke () override
 Action::onDelayedInvoke() implementation.
 
void onInvoke () override
 Action::onInvoke() implementation.
 
void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 PropertyObject::onPropertyChanged(AbstractPropertyType, PropertyNotificationReason) implementation.
 
- Protected Member Functions inherited from kanzi::Action
 Action (Domain *domain, string_view name)
 Constructor.
 
virtual void onPrepareDelayedInvoke ()
 Callback called by Kanzi when the action is invoked by its trigger with delay.
 
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 load (KzbFile &, KzbMemoryParser &parser)
 Overridable function for loading an action from a kzb file.
 
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::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value.
 
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.
 
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::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage.
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (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.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
 
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.
 
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.
 

Additional Inherited Members

- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- 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.
 
TriggergetTrigger () 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.
 
DomaingetDomain () const
 Returns the domain the object belongs to.
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object.
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain.
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object.
 
ResourceManagergetResourceManager () 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
 
 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 Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container.
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object.
 

Detailed Description

You can use ExecuteLuaAction to run a Lua script that implements application logic.

ExecuteLuaAction initializes Lua if it is not initialized to guarantee that the Lua script runs when the Action invokes.

To use the ExecuteLuaAction:

  • Create a BinaryResource that contains the Lua script that you want to run.
  • Register the binary resource to the resource manager.
  • Set the ScriptUrlProperty to the url of the binary resource.
  • Add the action to a trigger and the trigger to a node.
See also
Trigger, BinaryResource
Since
Kanzi 3.9.9

Constructor & Destructor Documentation

◆ ExecuteLuaAction()

kanzi::ExecuteLuaAction::ExecuteLuaAction ( Domain * domain,
string_view name )
explicitprotected

Constructor.

Parameters
domainThe domain.
nameName for the action.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ExecuteLuaAction::makeEditorInfo ( )
static

Provides the editor info.

◆ create()

static ExecuteLuaActionSharedPtr kanzi::ExecuteLuaAction::create ( Domain * domain,
string_view name )
static

Creates an ExecuteLuaAction.

Parameters
domainThe domain.
nameThe name of the action.
Returns
A shared pointer to the created action.

◆ clone()

ActionSharedPtr kanzi::ExecuteLuaAction::clone ( ) const
overrideprotectedvirtual

Action::clone() implementation.

Implements kanzi::Action.

◆ onInvoke()

void kanzi::ExecuteLuaAction::onInvoke ( )
overrideprotectedvirtual

Action::onInvoke() implementation.

Reimplemented from kanzi::Action.

◆ onDelayedInvoke()

void kanzi::ExecuteLuaAction::onDelayedInvoke ( )
overrideprotectedvirtual

Action::onDelayedInvoke() implementation.

Reimplemented from kanzi::Action.

◆ onAttach()

virtual void kanzi::ExecuteLuaAction::onAttach ( )
overrideprotectedvirtual

ActionBase::onAttach() implementation.

Reimplemented from kanzi::ActionBase.

◆ onPropertyChanged()

void kanzi::ExecuteLuaAction::onPropertyChanged ( AbstractPropertyType propertyType,
PropertyNotificationReason reason )
overrideprotectedvirtual

◆ loadScript()

bool kanzi::ExecuteLuaAction::loadScript ( BinaryResource & resource)
protected

Loads the resource script into Lua.

Parameters
resourceThe binary resource to load.
Returns
True when the script is loaded to the Lua instance.

◆ getLuaScriptResource()

BinaryResourceSharedPtr kanzi::ExecuteLuaAction::getLuaScriptResource ( ) const
protected

Returns the resource ScriptUrlProperty points to.

Returns
The resource ScriptUrlProperty points to.

Member Data Documentation

◆ ScriptUrlProperty

PropertyType<string> kanzi::ExecuteLuaAction::ScriptUrlProperty
static

Holds the url of the Lua script.


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