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

Holds the runtime state of a ResourceBindingProcessor. More...

#include <kanzi/core.ui/binding/resource_binding_processor_runtime.hpp>

Inheritance diagram for kanzi::ResourceBindingProcessorRuntime:
[legend]

Public Member Functions

void onResourceChange ()
 Function executed on resource change. More...
 
- Public Member Functions inherited from kanzi::BindingProcessorRuntime
void attach (AbstractBindingRuntime &bindingRuntime)
 Called when the binding source or target runtime containing the processor runtime is being attached. More...
 
void detach ()
 Called when the binding source or target runtime containing the processor runtime is being detached. More...
 
AbstractBindingRuntimegetBindingRuntime () const
 Gets the binding runtime. More...
 
BindingProcessorgetProcessor () const
 Gets the binding processor. More...
 
bool validate (Variant &value)
 Returns true if the BindingProcessorRuntime has a valid state. More...
 
virtual ~BindingProcessorRuntime ()=default
 Destructor. More...
 

Static Public Member Functions

static unique_ptr< ResourceBindingProcessorRuntimecreate (ResourceBindingProcessor &processor)
 Creates a ResourceBindingProcessorRuntime. More...
 
- Static Public Member Functions inherited from kanzi::InstructionBindingProcessorRuntime
static unique_ptr< InstructionBindingProcessorRuntimecreate (InstructionBindingProcessor &processor)
 Creates an InstructionBindingProcessorRuntime. More...
 

Protected Types

using ResourceListener = ContentReference< Resource >
 Resource listener type. More...
 
using ResourceListenerPtr = unique_ptr< ResourceListener >
 Resource listener unique pointer type. More...
 

Protected Member Functions

void attachOverride (AbstractBindingRuntime &bindingRuntime)
 BindingProcessorRuntime::attachOverride() implementation. More...
 
void detachOverride ()
 BindingProcessorRuntime::detachOverride() implementation. More...
 
 ResourceBindingProcessorRuntime (ResourceBindingProcessor &processor)
 Constructor. More...
 
bool validateOverride (Variant &value)
 BindingProcessorRuntime::validateOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::InstructionBindingProcessorRuntime
InstructionBindingProcessorgetInstructionBindingProcessor () const
 Casts BindingProcess into InstructionBindingProcessor. More...
 
 InstructionBindingProcessorRuntime (InstructionBindingProcessor &processor)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingProcessorRuntime
 BindingProcessorRuntime (BindingProcessor &processor)
 Constructor. More...
 

Protected Attributes

ResourceListenerPtr m_listener
 Listener for resource changes. More...
 
NodeWeakPtr m_node
 Node attached to (for recreating the listener). More...
 
- Protected Attributes inherited from kanzi::InstructionBindingProcessorRuntime
Variantm_inputRegister1
 Attached input register. More...
 
Variantm_inputRegister2
 Attached input register. More...
 
Variantm_inputRegister3
 Attached input register. More...
 
Variantm_outputRegister
 Attached output register. More...
 
- Protected Attributes inherited from kanzi::BindingProcessorRuntime
AbstractBindingRuntimem_bindingRuntime
 The binding runtime containing the BindingProcessorRuntime. More...
 
BindingProcessorm_processor
 The processor whose runtime state is held by the BindingProcessorRuntime. More...
 

Detailed Description

Holds the runtime state of a ResourceBindingProcessor.

Since
Kanzi 3.9.3

Member Typedef Documentation

Resource listener unique pointer type.

Constructor & Destructor Documentation

kanzi::ResourceBindingProcessorRuntime::ResourceBindingProcessorRuntime ( ResourceBindingProcessor processor)
explicitprotected

Constructor.

Parameters
processorThe ResourceBindingProcessor who's runtime state is held by the created ResourceBindingProcessorRuntime.

Member Function Documentation

static unique_ptr<ResourceBindingProcessorRuntime> kanzi::ResourceBindingProcessorRuntime::create ( ResourceBindingProcessor processor)
static

Creates a ResourceBindingProcessorRuntime.

Parameters
processorThe ResourceBindingProcessor who's runtime state is held by the created ResourceBindingProcessorRuntime.
Returns
A ResourceBindingProcessorRuntime instance.
void kanzi::ResourceBindingProcessorRuntime::onResourceChange ( )

Function executed on resource change.

When Kanzi executes this function, it also re-executes the binding.

void kanzi::ResourceBindingProcessorRuntime::attachOverride ( AbstractBindingRuntime bindingRuntime)
protectedvirtual
void kanzi::ResourceBindingProcessorRuntime::detachOverride ( )
protectedvirtual
bool kanzi::ResourceBindingProcessorRuntime::validateOverride ( Variant value)
protectedvirtual

Member Data Documentation

NodeWeakPtr kanzi::ResourceBindingProcessorRuntime::m_node
protected

Node attached to (for recreating the listener).

ResourceListenerPtr kanzi::ResourceBindingProcessorRuntime::m_listener
protected

Listener for resource changes.


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