Kanzi  3.9.5
Kanzi Engine API
kanzi::DummyBindingTargetRuntime Class Reference

Runtime for dummy binding target. More...

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

Inheritance diagram for kanzi::DummyBindingTargetRuntime:
[legend]

Static Public Member Functions

static BindingTargetRuntimePtr create ()
 Creates a dummy binding target runtime. More...
 

Protected Member Functions

void attachForWriteOverride () override
 BindingTargetRuntime::attachForWriteOverride() implementation. More...
 
void detachOverride () override
 BindingTargetRuntime::detachOverride() implementation. More...
 
 DummyBindingTargetRuntime ()
 Constructor. More...
 
bool isConnectedOverride () override
 BindingTargetRuntime::isConnectedOverride() implementation. More...
 
bool writeOverride (const Variant &value) override
 BindingTargetRuntime::writeOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::BindingTargetRuntime
virtual void attachForReadOverride ()
 Implementation-dependent attach. More...
 
 BindingTargetRuntime (BindingLookupContextPtr lookupContext)
 Constructor. More...
 
virtual bool readOverride (Variant &value)
 Implementation-dependent read. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::BindingTargetRuntime
using BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator
 Binding processor iterator type. More...
 
using BindingProcessorRuntimeContainer = vector< BindingProcessorRuntimePtr >
 Binding processor container type. More...
 
- Public Member Functions inherited from kanzi::BindingTargetRuntime
void attachForRead ()
 Attaches the binding target runtime for reading. More...
 
void attachForWrite ()
 Attaches the binding target runtime for writing. More...
 
BindingProcessorRuntimeConstIterator beginProcessorRuntimes () const
 Gets an iterator to the beginning of binding processor runtimes. More...
 
void createBindingProcessorsRuntimes (const AbstractBinding &binding)
 Creates a processor runtime for each BindingProcessor held by the binding parameter. More...
 
void detach ()
 Detaches binding target runtime. More...
 
BindingProcessorRuntimeConstIterator endProcessorRuntimes () const
 Gets an iterator to the end of binding processor runtimes. More...
 
AbstractBindingRuntimegetBindingRuntime () const
 Gets the binding runtime. More...
 
BindingLookupContextgetLookupContext () const
 Accesses target lookup context. More...
 
bool isConnected ()
 Indicates whether this source is connected. More...
 
bool read (Variant &value)
 Reads a value from the binding target. More...
 
void setBindingRuntime (AbstractBindingRuntime &bindingRuntime)
 Sets the binding runtime. More...
 
bool write (const Variant &value)
 Writes a value to the binding target. More...
 
virtual ~BindingTargetRuntime ()=default
 Destructor. More...
 
- Protected Attributes inherited from kanzi::BindingTargetRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this target. More...
 
BindingLookupContextPtr m_lookupContext
 Binding lookup context for wherever this binding target runtime is attached to. More...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors runtimes (for the target, backward direction). More...
 

Detailed Description

Runtime for dummy binding target.

Dummy binding target runtime is used when the binding has side effects that need to be executed, but writing to target value is not important. It is most commonly used with ToSourceBinding, that writes to a push source, but does not necessarily write a value in the target Node or RenderPass.

Dummy binding targets may also be used if the binding has other side effects that make writing the result value unnecessary, for example a CallbackBindingProcessor that executes user-defined code for the binding result value. Also ToSourceBinding is commonly used with DummyBindingTargetRuntime.

DummyBindingTargetRuntime is always considered to be connected.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

◆ DummyBindingTargetRuntime()

kanzi::DummyBindingTargetRuntime::DummyBindingTargetRuntime ( )
protected

Constructor.

Member Function Documentation

◆ create()

static BindingTargetRuntimePtr kanzi::DummyBindingTargetRuntime::create ( )
static

Creates a dummy binding target runtime.

Returns
the dummy binding target runtime.

◆ attachForWriteOverride()

void kanzi::DummyBindingTargetRuntime::attachForWriteOverride ( )
overrideprotectedvirtual

◆ detachOverride()

void kanzi::DummyBindingTargetRuntime::detachOverride ( )
overrideprotectedvirtual

◆ writeOverride()

bool kanzi::DummyBindingTargetRuntime::writeOverride ( const Variant value)
overrideprotectedvirtual

◆ isConnectedOverride()

bool kanzi::DummyBindingTargetRuntime::isConnectedOverride ( )
overrideprotectedvirtual

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