kanzi::TypedVariableBindingTargetRuntime< T > Class Template Reference

Typed runtime for variable binding target. More...

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

Inheritance diagram for kanzi::TypedVariableBindingTargetRuntime< T >:

Public Member Functions
bool	hasValue () const
	Indicates whether the value has been set.
bool	writeToVariant (Variant &value)
	Writes the contents of this target runtime to the given variant.
Public Member Functions inherited from kanzi::VariableBindingTargetRuntime
void	addVariableSource (AbstractBindingVariableSource &sourceRuntime)
	Adds a variable binding source runtime.
AbstractPropertyType	getPropertyType () const
	Gets property type.
AbstractBindingVariableSource *	removeLastVariableSource ()
	Removes the last variable source listening on this target.
void	removeSourceRuntime (AbstractBindingVariableSource &sourceRuntime)
	Removes a variable binding source runtime.
virtual	~VariableBindingTargetRuntime ()
	Destructor.
Public Member Functions inherited from kanzi::BindingTargetRuntime
void	attachForRead ()
	Attaches the binding target runtime for reading.
void	attachForWrite ()
	Attaches the binding target runtime for writing.
BindingProcessorRuntimeConstIterator	beginProcessorRuntimes () const
	Gets an iterator to the beginning of binding processor runtimes.
void	createBindingProcessorsRuntimes (const AbstractBinding &binding)
	Creates a processor runtime for each BindingProcessor held by the binding parameter.
void	detach ()
	Detaches binding target runtime.
BindingProcessorRuntimeConstIterator	endProcessorRuntimes () const
	Gets an iterator to the end of binding processor runtimes.
AbstractBindingRuntime *	getBindingRuntime () const
	Gets the binding runtime.
BindingLookupContext &	getLookupContext () const
	Gets the lookup context.
bool	isConnected ()
	Indicates whether this source is connected.
bool	read (Variant &value)
	Reads a value from the binding target.
void	setBindingRuntime (AbstractBindingRuntime &bindingRuntime)
	Sets the binding runtime.
bool	write (const Variant &value)
	Writes a value to the binding target.
virtual	~BindingTargetRuntime ()=default
	Destructor.

Static Public Member Functions
static BindingTargetRuntimePtr	create (AbstractPropertyType propertyType)
	Creates a typed variable binding target runtime.
Static Public Member Functions inherited from kanzi::VariableBindingTargetRuntime
static BindingTargetRuntimePtr	create (AbstractPropertyType propertyType)
	Creates a manual binding target runtime.

Protected Member Functions
void	notifyVariableSources ()
	Notify connected source runtimes.
	TypedVariableBindingTargetRuntime (AbstractPropertyType propertyType)
	Constructor.
bool	writeOverride (const Variant &value) override
	BindingTargetRuntime::writeOverride() implementation.
Protected Member Functions inherited from kanzi::VariableBindingTargetRuntime
void	attachForReadOverride () override
	BindingTargetRuntime::attachForReadOverride() implementation.
void	attachForWriteOverride () override
	BindingTargetRuntime::attachForWriteOverride() implementation.
void	detachOverride () override
	BindingTargetRuntime::detachOverride() implementation.
bool	isConnectedOverride () override
	BindingTargetRuntime::isConnectedOverride() implementation.
bool	readOverride (Variant &value) override
	BindingTargetRuntime::readOverride() implementation.
	VariableBindingTargetRuntime (AbstractPropertyType propertyType)
	Constructor.
Protected Member Functions inherited from kanzi::BindingTargetRuntime
	BindingTargetRuntime ()=default
	Constructor.

Protected Attributes
optional< T >	m_value
	Storage for the binding result.
Protected Attributes inherited from kanzi::VariableBindingTargetRuntime
VariableBindingHost *	m_host
	Variable binding host connected to.
AbstractPropertyType	m_propertyType
	Property type written.
vector< AbstractBindingVariableSource * >	m_sourceRuntimes
	Variable binding sources connected.
Protected Attributes inherited from kanzi::BindingTargetRuntime
AbstractBindingRuntime *	m_bindingRuntime
	Abstract binding runtime for this target.
BindingProcessorRuntimeContainer	m_processorRuntimes
	Binding processors runtimes (for the target, backward direction).

Additional Inherited Members
Public Types inherited from kanzi::VariableBindingTargetRuntime
using	VariableSourceContainer
	Container for variable sources.
Public Types inherited from kanzi::BindingTargetRuntime
using	BindingProcessorRuntimeConstIterator
	Binding processor iterator type.
using	BindingProcessorRuntimeContainer
	Binding processor container type.

Detailed Description

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

Typed runtime for variable binding target.

Since

Kanzi 3.9.0

Constructor & Destructor Documentation

TypedVariableBindingTargetRuntime()

template<typename T >

kanzi::TypedVariableBindingTargetRuntime< T >::TypedVariableBindingTargetRuntime ( AbstractPropertyType propertyType )

inlineexplicitprotected

Constructor.

Parameters

propertyType

Target property type.

Since

Kanzi 3.9.6 Removed BindingLookupContextPtr.

Member Function Documentation

create()

template<typename T >

static BindingTargetRuntimePtr kanzi::TypedVariableBindingTargetRuntime< T >::create ( AbstractPropertyType propertyType )

inlinestatic

Creates a typed variable binding target runtime.

Parameters

propertyType

Target property type.

Returns

The created manual binding target runtime.

Since

Kanzi 3.9.6 Removed BindingLookupContextPtr.

hasValue()

template<typename T >

bool kanzi::TypedVariableBindingTargetRuntime< T >::hasValue ( ) const

inline

Indicates whether the value has been set.

Returns

True if value has been assigned, false otherwise.

writeToVariant()

template<typename T >

bool kanzi::TypedVariableBindingTargetRuntime< T >::writeToVariant ( Variant & value )

inline

Writes the contents of this target runtime to the given variant.

Parameters

value

Value to write to.

Returns

True if there was a value to write.

notifyVariableSources()

template<typename T >

void kanzi::TypedVariableBindingTargetRuntime< T >::notifyVariableSources ( )

inlineprotected

Notify connected source runtimes.

Kanzi calls this function after the variable binding target has been written.

writeOverride()

template<typename T >

bool kanzi::TypedVariableBindingTargetRuntime< T >::writeOverride ( const Variant & value )

inlineoverrideprotectedvirtual

BindingTargetRuntime::writeOverride() implementation.

Implements kanzi::BindingTargetRuntime.

Member Data Documentation

m_value

template<typename T >

optional<T> kanzi::TypedVariableBindingTargetRuntime< T >::m_value

protected

Storage for the binding result.

---

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

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