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

Public Types
using	VariableBindingTargetType
	Type for the variable binding target that this variable binding source is reading from.

Public Member Functions
	~TypedVariableExpressionValueSourceRuntime () override=default
	Destructor.
Public Member Functions inherited from kanzi::VariableExpressionValueSourceRuntime
PropertyField	getPropertyField () const
	Gets property field.
Public Member Functions inherited from kanzi::AbstractExpressionValueSourceRuntime
void	attach ()
	Attaches this source.
void	detach ()
	Detaches this source.
Variant &	getRegister ()
	Gets the variant from this value source.
const Variant &	getRegister () const
	Gets the variant from this value source.
virtual	~AbstractExpressionValueSourceRuntime ()
	Destructor.
Public Member Functions inherited from kanzi::AbstractBindingVariableSource
AbstractPropertyType	getPropertyType () const
	Gets the associated property type for this variable source.
void	notifyVariableAvailable ()
	Notification function for when variable has become available or has been changed.
void	notifyVariableDetached ()
	Notification function for when variable has become detached and is no longer available.
void	setTargetRuntime (VariableBindingTargetRuntime *targetRuntime)
	Sets the variable binding target runtime.

Static Public Member Functions
static AbstractExpressionValueSourceRuntimePtr	create (VariableExpressionValueSource &valueSource, ExpressionBindingSourceRuntime &sourceRuntime)
	Create a typed variable expression value source runtime.

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

Additional Inherited Members
Protected Attributes inherited from kanzi::VariableExpressionValueSourceRuntime
const VariableExpressionValueSource &	m_source
	Create info containing settings for this source.
Protected Attributes inherited from kanzi::AbstractExpressionValueSourceRuntime
Variant	m_cachedValue
	Cached value stored.
ExpressionBindingSourceRuntime &	m_host
	Host multi binding source.
Protected Attributes inherited from kanzi::AbstractBindingVariableSource
VariableBindingTargetRuntime *	m_targetRuntime
	Currently connected target runtime.

Detailed Description

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

Typed runtime for variable expression value source.

Since

Kanzi 3.9.0

Member Typedef Documentation

VariableBindingTargetType

template<typename T >

using kanzi::TypedVariableExpressionValueSourceRuntime< T >::VariableBindingTargetType

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

Constructor & Destructor Documentation

~TypedVariableExpressionValueSourceRuntime()

template<typename T >

kanzi::TypedVariableExpressionValueSourceRuntime< T >::~TypedVariableExpressionValueSourceRuntime ( )

overridedefault

Destructor.

TypedVariableExpressionValueSourceRuntime()

template<typename T >

kanzi::TypedVariableExpressionValueSourceRuntime< T >::TypedVariableExpressionValueSourceRuntime ( VariableExpressionValueSource & source, ExpressionBindingSourceRuntime & host )

inlineprotected

Constructor.

Parameters

source	Source for this value source runtime.
host	Host expression binding source runtime.

Member Function Documentation

create()

template<typename T >

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

inlinestatic

Create a typed variable expression value source runtime.

Parameters

valueSource	Source for this value source runtime.
sourceRuntime	Host expression binding source runtime.

Returns

The created value source runtime.

getTargetRuntime()

template<typename T >

VariableBindingTargetType * kanzi::TypedVariableExpressionValueSourceRuntime< T >::getTargetRuntime ( )

inlineprotected

Gets the current target runtime as the correct type.

Returns

Variable target runtime connected to.

readValue()

template<typename T >

bool kanzi::TypedVariableExpressionValueSourceRuntime< T >::readValue ( Variant & value )

inlineprotected

Reads a value from connected variable binding target.

Parameters

value

Variant to read to.

Returns

True if value was read successfully.

attachOverride()

template<typename T >

void kanzi::TypedVariableExpressionValueSourceRuntime< T >::attachOverride ( )

inlineoverrideprotectedvirtual

AbstractExpressionValueSource::attachOverride() implementation.

Implements kanzi::AbstractExpressionValueSourceRuntime.

notifyVariableAvailableOverride()

template<typename T >

void kanzi::TypedVariableExpressionValueSourceRuntime< T >::notifyVariableAvailableOverride ( )

inlineoverrideprotectedvirtual

AbstractBindingVariableSource::notifyVariableAvailableOverride() implementation.

Implements kanzi::AbstractBindingVariableSource.

notifyVariableDetachedOverride()

template<typename T >

void kanzi::TypedVariableExpressionValueSourceRuntime< T >::notifyVariableDetachedOverride ( )

inlineoverrideprotectedvirtual

AbstractBindingVariableSource::notifyVariableDetachedOverride() implementation.

Implements kanzi::AbstractBindingVariableSource.

---

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

• kanzi/core.ui/binding/typed_variable_expression_value_source_runtime.hpp