Kanzi  3.9.7
Kanzi Engine API
kanzi::TypedVariableExpressionValueSourceRuntime< T > Class Template Reference

Typed runtime for variable expression value source. More...

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

Inheritance diagram for kanzi::TypedVariableExpressionValueSourceRuntime< T >:
[legend]

Public Types

using VariableBindingTargetType = TypedVariableBindingTargetRuntime< T >
 Type for the variable binding target that this variable binding source is reading from. More...
 

Public Member Functions

 ~TypedVariableExpressionValueSourceRuntime () override=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::VariableExpressionValueSourceRuntime
PropertyField getPropertyField () const
 Gets property field. More...
 
- Public Member Functions inherited from kanzi::AbstractExpressionValueSourceRuntime
void attach ()
 Attaches this source. More...
 
void detach ()
 Detaches this source. More...
 
VariantgetRegister ()
 Gets the variant from this value source. More...
 
const VariantgetRegister () const
 Gets the variant from this value source. More...
 
virtual ~AbstractExpressionValueSourceRuntime ()
 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 AbstractExpressionValueSourceRuntimePtr create (VariableExpressionValueSource &valueSource, ExpressionBindingSourceRuntime &sourceRuntime)
 Create a typed variable expression value source runtime. More...
 

Protected Member Functions

void attachOverride () override
 AbstractExpressionValueSource::attachOverride() implementation. More...
 
VariableBindingTargetTypegetTargetRuntime ()
 Gets the current target runtime as the correct type. More...
 
void notifyVariableAvailableOverride () override
 AbstractBindingVariableSource::notifyVariableAvailableOverride() implementation. More...
 
void notifyVariableDetachedOverride () override
 AbstractBindingVariableSource::notifyVariableDetachedOverride() implementation. More...
 
bool readValue (Variant &value)
 Reads a value from connected variable binding target. More...
 
 TypedVariableExpressionValueSourceRuntime (VariableExpressionValueSource &source, ExpressionBindingSourceRuntime &host)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::VariableExpressionValueSourceRuntime
void detachOverride () override
 AbstractExpressionValueSource::detachOverride() implementation. More...
 
BindingLookupContextgetLookupContext ()
 Gets the binding lookup context. More...
 
AbstractPropertyType getPropertyTypeOverride () const override
 AbstractBindingVariableSource::getPropertyType() implementation. More...
 
 VariableExpressionValueSourceRuntime (const VariableExpressionValueSource &source, ExpressionBindingSourceRuntime &host)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::AbstractExpressionValueSourceRuntime
 AbstractExpressionValueSourceRuntime (ExpressionBindingSourceRuntime &host)
 Constructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from kanzi::VariableExpressionValueSourceRuntime
const VariableExpressionValueSourcem_source
 Create info containing settings for this source. More...
 
- Protected Attributes inherited from kanzi::AbstractExpressionValueSourceRuntime
Variant m_cachedValue
 Cached value stored. More...
 
ExpressionBindingSourceRuntimem_host
 Host multi binding source. More...
 
- Protected Attributes inherited from kanzi::AbstractBindingVariableSource
VariableBindingTargetRuntimem_targetRuntime
 Currently connected target runtime. More...
 

Detailed Description

template<typename T>
class kanzi::TypedVariableExpressionValueSourceRuntime< T >

Typed runtime for variable expression value source.

Since
Kanzi 3.9.0

Member Typedef Documentation

Type for the variable binding target that this variable binding source is reading from.

Constructor & Destructor Documentation

Destructor.

Constructor.

Parameters
sourceSource for this value source runtime.
hostHost expression binding source runtime.

Member Function Documentation

template<typename T >
static AbstractExpressionValueSourceRuntimePtr kanzi::TypedVariableExpressionValueSourceRuntime< T >::create ( VariableExpressionValueSource valueSource,
ExpressionBindingSourceRuntime sourceRuntime 
)
inlinestatic

Create a typed variable expression value source runtime.

Parameters
valueSourceSource for this value source runtime.
sourceRuntimeHost expression binding source runtime.
Returns
The created value source runtime.
template<typename T >
VariableBindingTargetType* kanzi::TypedVariableExpressionValueSourceRuntime< T >::getTargetRuntime ( )
inlineprotected

Gets the current target runtime as the correct type.

Returns
Variable target runtime connected to.
template<typename T >
bool kanzi::TypedVariableExpressionValueSourceRuntime< T >::readValue ( Variant value)
inlineprotected

Reads a value from connected variable binding target.

Parameters
valueVariant to read to.
Returns
True if value was read successfully.
template<typename T >
void kanzi::TypedVariableExpressionValueSourceRuntime< T >::attachOverride ( )
inlineoverrideprotectedvirtual

AbstractExpressionValueSource::attachOverride() implementation.

Implements kanzi::AbstractExpressionValueSourceRuntime.

template<typename T >
void kanzi::TypedVariableExpressionValueSourceRuntime< T >::notifyVariableAvailableOverride ( )
inlineoverrideprotectedvirtual
template<typename T >
void kanzi::TypedVariableExpressionValueSourceRuntime< T >::notifyVariableDetachedOverride ( )
inlineoverrideprotectedvirtual

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