Kanzi  3.9.5
Kanzi Engine API
kanzi::ManualBindingTargetRuntime Class Reference

Runtime for manual binding target. More...

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

Inheritance diagram for kanzi::ManualBindingTargetRuntime:
[legend]

Public Member Functions

string getPath () const
 Gets path to object. More...
 
PropertyField getPropertyField () const
 Gets property type. More...
 
AbstractPropertyType getPropertyType () const
 Gets property 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...
 

Static Public Member Functions

static BindingTargetRuntimePtr create (BindingLookupContextPtr lookupContext, string_view path, AbstractPropertyType propertyType, PropertyField field)
 Creates a manual binding target runtime. More...
 

Protected Member Functions

void attachForReadOverride () override
 BindingTargetRuntime::attachForReadOverride() implementation. More...
 
void attachForWriteOverride () override
 BindingTargetRuntime::attachForWriteOverride() implementation. More...
 
void detachOverride () override
 BindingTargetRuntime::detachOverride() implementation. More...
 
bool isConnectedOverride () override
 BindingTargetRuntime::isConnectedOverride() implementation. More...
 
 ManualBindingTargetRuntime (BindingLookupContextPtr lookupContext, string_view path, AbstractPropertyType propertyType, PropertyField field)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingTargetRuntime
 BindingTargetRuntime (BindingLookupContextPtr lookupContext)
 Constructor. More...
 
virtual bool readOverride (Variant &value)
 Implementation-dependent read. More...
 
virtual bool writeOverride (const Variant &value)=0
 Implementation-dependent write. More...
 

Protected Attributes

PropertyField m_field
 Property field written. More...
 
string m_path
 Path to target object. More...
 
AbstractPropertyType m_propertyType
 Property type written. 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...
 

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

Detailed Description

Runtime for manual binding target.

Kanzi uses ManualBindingTargetRuntime internally for actions and triggers which require writing properties to other Node and RenderPass objects.

ManualBindingTargetRuntime is always considered to be connected. If the target object cannot be found, the binding is not executed.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

◆ ManualBindingTargetRuntime()

kanzi::ManualBindingTargetRuntime::ManualBindingTargetRuntime ( BindingLookupContextPtr  lookupContext,
string_view  path,
AbstractPropertyType  propertyType,
PropertyField  field 
)
protected

Constructor.

Parameters
lookupContextBinding lookup context to use.
pathTarget object path.
propertyTypeTarget property type.
fieldTarget property field.

Member Function Documentation

◆ create()

static BindingTargetRuntimePtr kanzi::ManualBindingTargetRuntime::create ( BindingLookupContextPtr  lookupContext,
string_view  path,
AbstractPropertyType  propertyType,
PropertyField  field 
)
static

Creates a manual binding target runtime.

Parameters
lookupContextLookup context for this binding target runtime.
pathTarget object path.
propertyTypeTarget property type.
fieldTarget property field.
Returns
The created manual binding target runtime.

◆ getPath()

string kanzi::ManualBindingTargetRuntime::getPath ( ) const
inline

Gets path to object.

Required by inheriting classes.

Returns
Path to object.

◆ getPropertyType()

AbstractPropertyType kanzi::ManualBindingTargetRuntime::getPropertyType ( ) const
inline

Gets property type.

Required by inheriting classes.

Returns
Property type listened to.

◆ getPropertyField()

PropertyField kanzi::ManualBindingTargetRuntime::getPropertyField ( ) const
inline

Gets property type.

Required by inheriting classes.

Returns
Property type listened to.

◆ attachForReadOverride()

void kanzi::ManualBindingTargetRuntime::attachForReadOverride ( )
overrideprotectedvirtual

◆ attachForWriteOverride()

void kanzi::ManualBindingTargetRuntime::attachForWriteOverride ( )
overrideprotectedvirtual

◆ detachOverride()

void kanzi::ManualBindingTargetRuntime::detachOverride ( )
overrideprotectedvirtual

◆ isConnectedOverride()

bool kanzi::ManualBindingTargetRuntime::isConnectedOverride ( )
overrideprotectedvirtual

Member Data Documentation

◆ m_path

string kanzi::ManualBindingTargetRuntime::m_path
protected

Path to target object.

◆ m_propertyType

AbstractPropertyType kanzi::ManualBindingTargetRuntime::m_propertyType
protected

Property type written.

◆ m_field

PropertyField kanzi::ManualBindingTargetRuntime::m_field
protected

Property field written.


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