Kanzi  3.9.4
Kanzi Engine API
kanzi::AbstractBindingVariableSource Class Referenceabstract

Abstract interface for VariableBindingSources and VariableExpressionValueSource. More...

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

Inheritance diagram for kanzi::AbstractBindingVariableSource:
[legend]

Public Member Functions

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

Protected Member Functions

virtual AbstractPropertyType getPropertyTypeOverride () const =0
 Implementation-dependent property type acquire. More...
 
virtual void notifyVariableAvailableOverride ()=0
 Implementation-dependent notification of variable being available or having been changed. More...
 
virtual void notifyVariableDetachedOverride ()=0
 Implementation-dependent notification of variable becoming detached. More...
 

Protected Attributes

VariableBindingTargetRuntimem_targetRuntime
 Currently connected target runtime. More...
 

Detailed Description

Abstract interface for VariableBindingSources and VariableExpressionValueSource.

Implements notification interface for VariableBindingTarget state changes being notified to connected sources.

Since
Kanzi 3.9.0

Member Function Documentation

◆ setTargetRuntime()

void kanzi::AbstractBindingVariableSource::setTargetRuntime ( VariableBindingTargetRuntime targetRuntime)
inline

Sets the variable binding target runtime.

Only called by VariableBindingTargetRuntime upon connection and disconnection.

Parameters
targetRuntimeVariable target runtime connected to.

◆ getPropertyType()

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

Gets the associated property type for this variable source.

Returns
Property type.

◆ notifyVariableAvailable()

void kanzi::AbstractBindingVariableSource::notifyVariableAvailable ( )
inline

Notification function for when variable has become available or has been changed.

Called by VariableBindingTargetRuntime for each connected variable source.

◆ notifyVariableDetached()

void kanzi::AbstractBindingVariableSource::notifyVariableDetached ( )
inline

Notification function for when variable has become detached and is no longer available.

Called by VariableBindingTargetRuntime for each connected variable source.

◆ getPropertyTypeOverride()

virtual AbstractPropertyType kanzi::AbstractBindingVariableSource::getPropertyTypeOverride ( ) const
protectedpure virtual

Implementation-dependent property type acquire.

Returns
Property type.

Implemented in kanzi::VariableBindingSourceRuntime, and kanzi::VariableExpressionValueSourceRuntime.

◆ notifyVariableAvailableOverride()

virtual void kanzi::AbstractBindingVariableSource::notifyVariableAvailableOverride ( )
protectedpure virtual

Implementation-dependent notification of variable being available or having been changed.

Implemented in kanzi::TypedVariableExpressionValueSourceRuntime< T >, and kanzi::VariableBindingSourceRuntime.

◆ notifyVariableDetachedOverride()

virtual void kanzi::AbstractBindingVariableSource::notifyVariableDetachedOverride ( )
protectedpure virtual

Implementation-dependent notification of variable becoming detached.

Implemented in kanzi::TypedVariableExpressionValueSourceRuntime< T >, and kanzi::VariableBindingSourceRuntime.

Member Data Documentation

◆ m_targetRuntime

VariableBindingTargetRuntime* kanzi::AbstractBindingVariableSource::m_targetRuntime
protected

Currently connected target runtime.


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