Typed runtime for variable binding source. More...

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

Inheritance diagram for kanzi::TypedVariableBindingSourceRuntime< T >:

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

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

Public Member Functions
	~TypedVariableBindingSourceRuntime () override
	Destructor. More...

Public Member Functions inherited from kanzi::VariableBindingSourceRuntime
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...

AbstractBindingRuntime *	getBindingRuntime () const
	Returns the source lookup context. More...

BindingLookupContext &	getLookupContext () 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 &source, BindingLookupContextPtr lookupContext)
	Creates a typed variable binding source runtime. More...

Static Public Member Functions inherited from kanzi::VariableBindingSourceRuntime
static BindingSourceRuntimePtr	create (const VariableBindingSource &bindingSource, BindingLookupContextPtr lookupContext)
	Creates a manual binding source runtime. More...

Protected Member Functions
void	attachForReadOverride () override
	BindingSourceRuntime::attachForReadOverride() implementation. More...

VariableBindingTargetType *	getTargetRuntime ()
	Gets the current target runtime as the correct type. More...

bool	isConnectedOverride () override
	BindingSourceRuntime::isConnectedOverride() implementation. More...

bool	readOverride (Variant &value) override
	BindingSourceRuntime::readOverride() implementation. More...

	TypedVariableBindingSourceRuntime (const VariableBindingSource &source, BindingLookupContextPtr lookupContext)
	Constructor. More...

Protected Member Functions inherited from kanzi::VariableBindingSourceRuntime
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
	BindingSourceRuntime (BindingLookupContextPtr lookupContext)
	Constructor. More...

virtual bool	writeOverride (const Variant &value)
	Implementation-dependent write. More...

Additional Inherited Members
Protected Attributes inherited from kanzi::VariableBindingSourceRuntime
const VariableBindingSource &	m_source
	Binding source that created this runtime. More...

Protected Attributes inherited from kanzi::BindingSourceRuntime
AbstractBindingRuntime *	m_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
VariableBindingTargetRuntime *	m_targetRuntime
	Currently connected target runtime. More...

Detailed Description

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

Typed runtime for variable binding source.

Since: Kanzi 3.9.0

Member Typedef Documentation

◆ VariableBindingTargetType

template<typename T >

using kanzi::TypedVariableBindingSourceRuntime< T >::VariableBindingTargetType = TypedVariableBindingTargetRuntime<T>

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

Constructor & Destructor Documentation

◆ ~TypedVariableBindingSourceRuntime()

template<typename T >

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

inlineoverride

Destructor.

◆ TypedVariableBindingSourceRuntime()

template<typename T >

kanzi::TypedVariableBindingSourceRuntime< T >::TypedVariableBindingSourceRuntime	(	const VariableBindingSource &	source,
		BindingLookupContextPtr	lookupContext
	)

inlineexplicitprotected

Constructor.

Parameters

source	Host variable property binding source.
lookupContext	Binding lookup context for this target.

Member Function Documentation

◆ create()

template<typename T >

static BindingSourceRuntimePtr kanzi::TypedVariableBindingSourceRuntime< T >::create	(	const VariableBindingSource &	source,
		BindingLookupContextPtr	lookupContext
	)

inlinestatic

Creates a typed variable binding source runtime.

Parameters

source	Host variable binding source.
lookupContext	Binding lookup context for this target.

Returns: The created typed variable binding source runtime.

◆ getTargetRuntime()

template<typename T >

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

inlineprotected

Gets the current target runtime as the correct type.

Returns: Variable target runtime connected to.

◆ attachForReadOverride()

template<typename T >

void kanzi::TypedVariableBindingSourceRuntime< T >::attachForReadOverride ( )

inlineoverrideprotectedvirtual

BindingSourceRuntime::attachForReadOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ isConnectedOverride()

template<typename T >

bool kanzi::TypedVariableBindingSourceRuntime< T >::isConnectedOverride ( )

inlineoverrideprotectedvirtual

BindingSourceRuntime::isConnectedOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ readOverride()

template<typename T >

bool kanzi::TypedVariableBindingSourceRuntime< T >::readOverride ( Variant & value )

inlineoverrideprotectedvirtual

BindingSourceRuntime::readOverride() implementation.

Implements kanzi::BindingSourceRuntime.

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

kanzi/core.ui/binding/typed_variable_binding_source_runtime.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ VariableBindingTargetType

Constructor & Destructor Documentation

◆ ~TypedVariableBindingSourceRuntime()

◆ TypedVariableBindingSourceRuntime()

Member Function Documentation

◆ create()

◆ getTargetRuntime()

◆ attachForReadOverride()

◆ isConnectedOverride()

◆ readOverride()

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