Runtime for expression binding source. More...

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

Inheritance diagram for kanzi::ExpressionBindingSourceRuntime:

Public Types
using	ExpressionValueSourceRuntimeContainer = vector< AbstractExpressionValueSourceRuntimePtr >
	Container for expression value sources. 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
const BindingProcessorRuntimeConstIterator	beginOperationProcessors ()
	Gets an iterator to the beginning of operation binding processors vector. More...

const BindingProcessorRuntimeConstIterator	endOperationProcessors ()
	Gets an iterator to the end of operation binding processors vector. More...

AbstractExpressionValueSourceRuntime *	getDataSourceValueSourceRuntime (size_t idx)
	Gets data source value source runtime by index. More...

const AbstractExpressionValueSourceRuntime *	getDataSourceValueSourceRuntime (size_t idx) const
	Gets data source value source runtime by index. More...

AbstractExpressionValueSourceRuntime *	getExpressionValueSourceRuntime (size_t idx)
	Gets expression value source runtime by index. More...

const AbstractExpressionValueSourceRuntime *	getExpressionValueSourceRuntime (size_t idx) const
	Gets expression value source runtime by index. More...

Variant *	getTemporaryRegister (size_t idx)
	Accesses temporary register. More...

const Variant *	getTemporaryRegister (size_t idx) const
	Accesses temporary register. More...

Variant *	resolveRegister (BindingExpressionArgumentType argumentType)
	Resolves a register based on argument type. More...

template<typename T >
void	setCurrentValue (T &value)
	Templated function for setting the current value. More...

void	sourceConnected ()
	Called by expression value sources when a source connects. More...

void	sourceDisconnected ()
	Called by expression value sources when a source disconnects. More...

void	sourceValueChanged ()
	Called by expression value sources when a source value changes. 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...

Static Public Member Functions
static BindingSourceRuntimePtr	create (ExpressionBindingSource &bindingSource, BindingLookupContextPtr lookupContext)
	Creates an expression binding source runtime. More...

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

void	attachForWriteOverride () override
	BindingSourceRuntime::attachForWriteOverride() implementation. More...

void	detachOverride () override
	BindingSourceRuntime::detachOverride() implementation. More...

bool	evaluateOpCodeContinueIf (const BindingExpressionOpCode &opCode, bool &out_continue)
	Performs the continueIf(condition) operation. More...

bool	executeOpCodeDefault (const BindingExpressionOpCode &opCode)
	Perform typical operation. More...

bool	executeOpCodeGetCurrentValue (const BindingExpressionOpCode &opCode)
	Perform getCurrentValue() operation. More...

bool	executeProcessorOperation (const BindingExpressionOpCode &opCode)
	Performs a binding processor operation. More...

	ExpressionBindingSourceRuntime (ExpressionBindingSource &bindingSource, BindingLookupContextPtr lookupContext)
	Constructor. More...

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

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

Protected Member Functions inherited from kanzi::BindingSourceRuntime
	BindingSourceRuntime (BindingLookupContextPtr lookupContext)
	Constructor. More...

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

Protected Attributes
size_t	m_connectedSourceCount
	Number of connected sources. More...

Variant	m_currentValueVariant
	Generated variant. More...

BindingSourceRuntime::BindingProcessorRuntimeContainer	m_operationProcessorRuntimes
	Binding sources copied from expression binding source. More...

ExpressionBindingSource &	m_source
	Host expression binding source. More...

ExpressionValueSourceRuntimeContainer	m_sources [2]
	Sources for data sources and other value sources. More...

bool	m_sourceValueChangeListenerRequested
	Indicates whether source value changes trigger the binding. 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...

Detailed Description

Runtime for expression binding source.

Since: Kanzi 3.7.0

Member Typedef Documentation

◆ ExpressionValueSourceRuntimeContainer

using kanzi::ExpressionBindingSourceRuntime::ExpressionValueSourceRuntimeContainer = vector<AbstractExpressionValueSourceRuntimePtr>

Container for expression value sources.

Constructor & Destructor Documentation

◆ ExpressionBindingSourceRuntime()

kanzi::ExpressionBindingSourceRuntime::ExpressionBindingSourceRuntime	(	ExpressionBindingSource &	bindingSource,
		BindingLookupContextPtr	lookupContext
	)

explicitprotected

Constructor.

Parameters

bindingSource	Host expression binding source.
lookupContext	Binding lookup context for this source.

Member Function Documentation

◆ create()

static BindingSourceRuntimePtr kanzi::ExpressionBindingSourceRuntime::create	(	ExpressionBindingSource &	bindingSource,
		BindingLookupContextPtr	lookupContext
	)

static

Creates an expression binding source runtime.

Parameters

bindingSource	Parent binding source.
lookupContext	Lookup context for this binding source.

Returns: The created expression binding source runtime.

◆ sourceConnected()

void kanzi::ExpressionBindingSourceRuntime::sourceConnected ( )

Called by expression value sources when a source connects.

◆ sourceDisconnected()

void kanzi::ExpressionBindingSourceRuntime::sourceDisconnected ( )

Called by expression value sources when a source disconnects.

◆ sourceValueChanged()

void kanzi::ExpressionBindingSourceRuntime::sourceValueChanged ( )

Called by expression value sources when a source value changes.

◆ resolveRegister()

Variant* kanzi::ExpressionBindingSourceRuntime::resolveRegister ( BindingExpressionArgumentType argumentType )

Resolves a register based on argument type.

Parameters

argumentType Register identifier.

Returns: Reference to the register.

◆ setCurrentValue()

template<typename T >

void kanzi::ExpressionBindingSourceRuntime::setCurrentValue ( T & value )

inline

Templated function for setting the current value.

Stores the pointer and conversion function to generate the variant for given type. If current value is not used, the variant is never created.

Parameters

value Value that should be set to the register.

◆ getExpressionValueSourceRuntime() [1/2]

AbstractExpressionValueSourceRuntime* kanzi::ExpressionBindingSourceRuntime::getExpressionValueSourceRuntime ( size_t idx )

inline

Gets expression value source runtime by index.

Parameters

idx Index.

Returns: Pointer to expression value source runtime.

◆ getExpressionValueSourceRuntime() [2/2]

const AbstractExpressionValueSourceRuntime* kanzi::ExpressionBindingSourceRuntime::getExpressionValueSourceRuntime ( size_t idx ) const

inline

Gets expression value source runtime by index.

Parameters

idx Index.

Returns: Pointer to expression value source runtime.

◆ getDataSourceValueSourceRuntime() [1/2]

AbstractExpressionValueSourceRuntime* kanzi::ExpressionBindingSourceRuntime::getDataSourceValueSourceRuntime ( size_t idx )

inline

Gets data source value source runtime by index.

Parameters

idx Index.

Returns: Pointer to data source value source runtime.

◆ getDataSourceValueSourceRuntime() [2/2]

const AbstractExpressionValueSourceRuntime* kanzi::ExpressionBindingSourceRuntime::getDataSourceValueSourceRuntime ( size_t idx ) const

inline

Gets data source value source runtime by index.

Parameters

idx Index.

Returns: Pointer to data source value source runtime.

◆ getTemporaryRegister() [1/2]

Variant* kanzi::ExpressionBindingSourceRuntime::getTemporaryRegister ( size_t idx )

inline

Accesses temporary register.

Parameters

idx Index.

Returns: Reference to the temporary register.

◆ getTemporaryRegister() [2/2]

const Variant* kanzi::ExpressionBindingSourceRuntime::getTemporaryRegister ( size_t idx ) const

inline

Accesses temporary register.

Parameters

idx Index.

Returns: Reference to the temporary register.

◆ beginOperationProcessors()

const BindingProcessorRuntimeConstIterator kanzi::ExpressionBindingSourceRuntime::beginOperationProcessors ( )

inline

Gets an iterator to the beginning of operation binding processors vector.

Returns: iterator to the beginning of operation binding processors vector.

◆ endOperationProcessors()

const BindingProcessorRuntimeConstIterator kanzi::ExpressionBindingSourceRuntime::endOperationProcessors ( )

inline

Gets an iterator to the end of operation binding processors vector.

Returns: iterator to the end of operation binding processors vector.

◆ attachForReadOverride()

void kanzi::ExpressionBindingSourceRuntime::attachForReadOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::attachForReadOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ attachForWriteOverride()

void kanzi::ExpressionBindingSourceRuntime::attachForWriteOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::attachForWriteOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ detachOverride()

void kanzi::ExpressionBindingSourceRuntime::detachOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::detachOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ readOverride()

bool kanzi::ExpressionBindingSourceRuntime::readOverride ( Variant & value )

overrideprotectedvirtual

BindingSourceRuntime::readOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ isConnectedOverride()

bool kanzi::ExpressionBindingSourceRuntime::isConnectedOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::isConnectedOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ executeProcessorOperation()

bool kanzi::ExpressionBindingSourceRuntime::executeProcessorOperation ( const BindingExpressionOpCode & opCode )

protected

Performs a binding processor operation.

Parameters

opCode Operation code.

Returns: If the operation executes without errors, true, otherwise false.

◆ executeOpCodeDefault()

bool kanzi::ExpressionBindingSourceRuntime::executeOpCodeDefault ( const BindingExpressionOpCode & opCode )

protected

Perform typical operation.

Parameters

opCode Operation code.

Returns: True if the operation executed without errors, otherwise false.

◆ evaluateOpCodeContinueIf()

bool kanzi::ExpressionBindingSourceRuntime::evaluateOpCodeContinueIf	(	const BindingExpressionOpCode &	opCode,
		bool &	out_continue
	)

protected

Performs the continueIf(condition) operation.

Parameters

opCode	Operation code.
out_continue	Is set to true when the condition that you pass to the instruction evaluates to true.

Returns: If the operation executes without errors, true, otherwise false.

Since: Kanzi 3.9.5

◆ executeOpCodeGetCurrentValue()

bool kanzi::ExpressionBindingSourceRuntime::executeOpCodeGetCurrentValue ( const BindingExpressionOpCode & opCode )

protected

Perform getCurrentValue() operation.

Parameters

opCode Operation code.

Returns: True if the operation executed without errors, otherwise false.

Member Data Documentation

◆ m_sources

ExpressionValueSourceRuntimeContainer kanzi::ExpressionBindingSourceRuntime::m_sources[2]

protected

Sources for data sources and other value sources.

Value sources are index 0, data sources are index 1.

◆ m_connectedSourceCount

size_t kanzi::ExpressionBindingSourceRuntime::m_connectedSourceCount

protected

Number of connected sources.

◆ m_sourceValueChangeListenerRequested

bool kanzi::ExpressionBindingSourceRuntime::m_sourceValueChangeListenerRequested

protected

Indicates whether source value changes trigger the binding.

◆ m_operationProcessorRuntimes

BindingSourceRuntime::BindingProcessorRuntimeContainer kanzi::ExpressionBindingSourceRuntime::m_operationProcessorRuntimes

protected

Binding sources copied from expression binding source.

◆ m_currentValueVariant

Variant kanzi::ExpressionBindingSourceRuntime::m_currentValueVariant

protected

Generated variant.

Cleared at the end of execution.

◆ m_source

ExpressionBindingSource& kanzi::ExpressionBindingSourceRuntime::m_source

protected

Host expression binding source.

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

kanzi/core.ui/binding/expression_binding_source_runtime.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ExpressionValueSourceRuntimeContainer

Constructor & Destructor Documentation

◆ ExpressionBindingSourceRuntime()

Member Function Documentation

◆ create()

◆ sourceConnected()

◆ sourceDisconnected()

◆ sourceValueChanged()

◆ resolveRegister()

◆ setCurrentValue()

◆ getExpressionValueSourceRuntime() [1/2]

◆ getExpressionValueSourceRuntime() [2/2]

◆ getDataSourceValueSourceRuntime() [1/2]

◆ getDataSourceValueSourceRuntime() [2/2]

◆ getTemporaryRegister() [1/2]

◆ getTemporaryRegister() [2/2]

◆ beginOperationProcessors()

◆ endOperationProcessors()

◆ attachForReadOverride()

◆ attachForWriteOverride()

◆ detachOverride()

◆ readOverride()

◆ isConnectedOverride()

◆ executeProcessorOperation()

◆ executeOpCodeDefault()

◆ evaluateOpCodeContinueIf()

◆ executeOpCodeGetCurrentValue()

Member Data Documentation

◆ m_sources

◆ m_connectedSourceCount

◆ m_sourceValueChangeListenerRequested

◆ m_operationProcessorRuntimes

◆ m_currentValueVariant

◆ m_source