Kanzi  3.9.5
Kanzi Engine API
kanzi::VariableBindingSourceRuntime Class Reference

Runtime for variable binding source. More...

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

Inheritance diagram for kanzi::VariableBindingSourceRuntime:
[legend]

Public Member Functions

PropertyField getPropertyField () const
 Gets property field. More...
 
- Public Member Functions inherited from kanzi::BindingSourceRuntime
void attachForRead ()
 Attaches the binding source runtime for reading. More...
 
void attachForWrite ()
 Attaches the binding source runtime for writing. More...
 
BindingProcessorRuntimeConstIterator beginProcessorRuntimes () const
 Gets an iterator to the beginning of binding processors. More...
 
void createBindingProcessorRuntimes (const AbstractBinding &binding)
 Creates a processor runtime for each BindingProcessor held by the binding parameter. More...
 
void detach ()
 Detaches the binding source runtime. More...
 
BindingProcessorRuntimeConstIterator endProcessorRuntimes () const
 Gets an iterator to the end of binding processors. More...
 
AbstractBindingRuntimegetBindingRuntime () const
 Returns the source lookup context. More...
 
BindingLookupContextgetLookupContext () const
 Returns the source lookup context. More...
 
bool isConnected ()
 Indicates whether this source is connected. More...
 
bool read (Variant &value)
 Reads a value from binding source. More...
 
void setBindingRuntime (AbstractBindingRuntime &bindingRuntime)
 Sets the binding runtime. More...
 
bool write (const Variant &value)
 Writes a value to binding source. More...
 
virtual ~BindingSourceRuntime ()=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::AbstractBindingVariableSource
AbstractPropertyType getPropertyType () const
 Gets the associated property type for this variable source. More...
 
void notifyVariableAvailable ()
 Notification function for when variable has become available or has been changed. More...
 
void notifyVariableDetached ()
 Notification function for when variable has become detached and is no longer available. More...
 
void setTargetRuntime (VariableBindingTargetRuntime *targetRuntime)
 Sets the variable binding target runtime. More...
 

Static Public Member Functions

static BindingSourceRuntimePtr create (const VariableBindingSource &bindingSource, BindingLookupContextPtr lookupContext)
 Creates a manual binding source runtime. More...
 

Protected Member Functions

void attachForWriteOverride () override
 BindingSourceRuntime::attachForWriteOverride() implementation. More...
 
void detachOverride () override
 BindingSourceRuntime::detachOverride() implementation. More...
 
AbstractPropertyType getPropertyTypeOverride () const override
 AbstractBindingVariableSource::getPropertyType() implementation. More...
 
void notifyVariableAvailableOverride () override
 AbstractBindingVariableSource::notifyVariableAvailableOverride() implementation. More...
 
void notifyVariableDetachedOverride () override
 AbstractBindingVariableSource::notifyVariableDetachedOverride() implementation. More...
 
 VariableBindingSourceRuntime (const VariableBindingSource &bindingSource, BindingLookupContextPtr lookupContext)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingSourceRuntime
virtual void attachForReadOverride ()=0
 Implementation-dependent attach for read. More...
 
 BindingSourceRuntime (BindingLookupContextPtr lookupContext)
 Constructor. More...
 
virtual bool isConnectedOverride ()=0
 Implementation-dependent connected check. More...
 
virtual bool readOverride (Variant &value)=0
 Implementation-dependent read. More...
 
virtual bool writeOverride (const Variant &value)
 Implementation-dependent write. More...
 

Protected Attributes

const VariableBindingSourcem_source
 Binding source that created this runtime. More...
 
- Protected Attributes inherited from kanzi::BindingSourceRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this source. More...
 
BindingLookupContextPtr m_lookupContext
 Binding lookup context for wherever this binding source runtime is attached to. More...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors (for the source, forward direction). More...
 
- Protected Attributes inherited from kanzi::AbstractBindingVariableSource
VariableBindingTargetRuntimem_targetRuntime
 Currently connected target runtime. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::BindingSourceRuntime
using BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator
 Binding processor runtime constant iterator type. More...
 
using BindingProcessorRuntimeContainer = vector< BindingProcessorRuntimePtr >
 Binding processor runtime container type. More...
 

Detailed Description

Runtime for variable binding source.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ VariableBindingSourceRuntime()

kanzi::VariableBindingSourceRuntime::VariableBindingSourceRuntime ( const VariableBindingSource bindingSource,
BindingLookupContextPtr  lookupContext 
)
inlineexplicitprotected

Constructor.

Parameters
bindingSourceBinding source that created this runtime.
lookupContextLookup context of the binding source runtime.

Member Function Documentation

◆ create()

static BindingSourceRuntimePtr kanzi::VariableBindingSourceRuntime::create ( const VariableBindingSource bindingSource,
BindingLookupContextPtr  lookupContext 
)
static

Creates a manual binding source runtime.

Parameters
bindingSourceBinding source that created this runtime.
lookupContextLookup context of the binding source runtime.
Returns
The created manual binding source runtime.

◆ getPropertyField()

PropertyField kanzi::VariableBindingSourceRuntime::getPropertyField ( ) const

Gets property field.

Returns
Property type for this source.

◆ attachForWriteOverride()

void kanzi::VariableBindingSourceRuntime::attachForWriteOverride ( )
overrideprotectedvirtual

◆ detachOverride()

void kanzi::VariableBindingSourceRuntime::detachOverride ( )
overrideprotectedvirtual

◆ getPropertyTypeOverride()

AbstractPropertyType kanzi::VariableBindingSourceRuntime::getPropertyTypeOverride ( ) const
overrideprotectedvirtual

◆ notifyVariableAvailableOverride()

void kanzi::VariableBindingSourceRuntime::notifyVariableAvailableOverride ( )
overrideprotectedvirtual

◆ notifyVariableDetachedOverride()

void kanzi::VariableBindingSourceRuntime::notifyVariableDetachedOverride ( )
overrideprotectedvirtual

Member Data Documentation

◆ m_source

const VariableBindingSource& kanzi::VariableBindingSourceRuntime::m_source
protected

Binding source that created this runtime.


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