Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::BindingTargetRuntime Class Referenceabstract

Binding target runtime interface. More...

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

Inheritance diagram for kanzi::BindingTargetRuntime:
[legend]

Public Types

using BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator
 Binding processor iterator type. More...
 
using BindingProcessorRuntimeContainer = vector< BindingProcessorRuntimePtr >
 Binding processor container type. More...
 

Public Member Functions

void attachForRead ()
 Attaches the binding target runtime for reading. More...
 
void attachForWrite ()
 Attaches the binding target runtime for writing. More...
 
BindingProcessorRuntimeConstIterator beginProcessorRuntimes () const
 Gets an iterator to the beginning of binding processor runtimes. More...
 
void createBindingProcessorsRuntimes (const AbstractBinding &binding)
 Creates a processor runtime for each BindingProcessor held by the binding parameter. More...
 
void detach ()
 Detaches binding target runtime. More...
 
BindingProcessorRuntimeConstIterator endProcessorRuntimes () const
 Gets an iterator to the end of binding processor runtimes. More...
 
AbstractBindingRuntimegetBindingRuntime () const
 Gets the binding runtime. More...
 
BindingLookupContextgetLookupContext () const
 Gets the lookup context. More...
 
bool isConnected ()
 Indicates whether this source is connected. More...
 
bool read (Variant &value)
 Reads a value from the binding target. More...
 
void setBindingRuntime (AbstractBindingRuntime &bindingRuntime)
 Sets the binding runtime. More...
 
bool write (const Variant &value)
 Writes a value to the binding target. More...
 
virtual ~BindingTargetRuntime ()=default
 Destructor. More...
 

Protected Member Functions

virtual void attachForReadOverride ()
 Implementation-dependent attach. More...
 
virtual void attachForWriteOverride ()=0
 Implementation-dependent attach. More...
 
 BindingTargetRuntime ()=default
 Constructor. More...
 
virtual void detachOverride ()=0
 Implementation-dependent detach. More...
 
virtual bool isConnectedOverride ()=0
 Implementation-dependent connected check. More...
 
virtual bool readOverride (Variant &value)
 Implementation-dependent read. More...
 
virtual bool writeOverride (const Variant &value)=0
 Implementation-dependent write. More...
 

Protected Attributes

AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this target. More...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors runtimes (for the target, backward direction). More...
 

Detailed Description

Binding target runtime interface.

Inherited by specialized binding target runtimes.

See also
AbstractBinding
Since
Kanzi 3.7.0

Member Typedef Documentation

using kanzi::BindingTargetRuntime::BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator

Binding processor iterator type.

Constructor & Destructor Documentation

virtual kanzi::BindingTargetRuntime::~BindingTargetRuntime ( )
virtualdefault

Destructor.

kanzi::BindingTargetRuntime::BindingTargetRuntime ( )
explicitprotecteddefault

Constructor.

Since
Kanzi 3.9.6 Removed BindingLookupContextPtr.

Member Function Documentation

void kanzi::BindingTargetRuntime::attachForRead ( )

Attaches the binding target runtime for reading.

After attaching the binding target runtime for reading, the binding target triggers calls to AbstractBindingRuntime::notifyTargetChanged(). Calling this function on binding targets is optional. The binding runtime calls this function if target write notifications are necessary. This is true mostly for two-way bindings. You must call attachForWrite() before calling this function.

void kanzi::BindingTargetRuntime::attachForWrite ( )

Attaches the binding target runtime for writing.

After this function is called and the target is connected, you can call the write() function to write values to target. You must call this function before calling attachForRead().

void kanzi::BindingTargetRuntime::detach ( )

Detaches binding target runtime.

bool kanzi::BindingTargetRuntime::read ( Variant value)

Reads a value from the binding target.

Parameters
valueOutput value for the read.
Returns
Read success status.
bool kanzi::BindingTargetRuntime::write ( const Variant value)

Writes a value to the binding target.

Internal function called by Kanzi to write the output value to the binding target. If multiple values are written, Kanzi calls spill() instead.

Parameters
valueValue to write.
Returns
Write success status.
bool kanzi::BindingTargetRuntime::isConnected ( )

Indicates whether this source is connected.

Returns
If the source is connected, true, otherwise false.
void kanzi::BindingTargetRuntime::createBindingProcessorsRuntimes ( const AbstractBinding binding)

Creates a processor runtime for each BindingProcessor held by the binding parameter.

Parameters
bindingThe binding containing a collection of processors.
BindingProcessorRuntimeConstIterator kanzi::BindingTargetRuntime::beginProcessorRuntimes ( ) const
inline

Gets an iterator to the beginning of binding processor runtimes.

Returns
Iterator to beginning of processor runtimes vector.
BindingProcessorRuntimeConstIterator kanzi::BindingTargetRuntime::endProcessorRuntimes ( ) const
inline

Gets an iterator to the end of binding processor runtimes.

Returns
Iterator to end of processor runtimes vector.
BindingLookupContext& kanzi::BindingTargetRuntime::getLookupContext ( ) const
inline

Gets the lookup context.

Returns
The binding lookup context.
AbstractBindingRuntime* kanzi::BindingTargetRuntime::getBindingRuntime ( ) const
inline

Gets the binding runtime.

Returns
Pointer to owning binding runtime.
void kanzi::BindingTargetRuntime::setBindingRuntime ( AbstractBindingRuntime bindingRuntime)
inline

Sets the binding runtime.

Called during construction, after target runtime has been set to binding runtime.

Parameters
bindingRuntimeBinding runtime to set.
virtual void kanzi::BindingTargetRuntime::attachForReadOverride ( )
protectedvirtual
virtual bool kanzi::BindingTargetRuntime::readOverride ( Variant value)
protectedvirtual

Implementation-dependent read.

Default implementation throws an error.

Parameters
valueValue to read.
Returns
If the reading succeeds, true, otherwise false.

Reimplemented in kanzi::TypedValueSourceBindingTargetRuntime< T >, kanzi::TypedPropertyModifierBindingTargetRuntime< T >, kanzi::VariableBindingTargetRuntime, kanzi::TypedManualBindingTargetRuntime< T >, and kanzi::TypedMessageBindingTargetRuntime< T >.

virtual bool kanzi::BindingTargetRuntime::writeOverride ( const Variant value)
protectedpure virtual
virtual bool kanzi::BindingTargetRuntime::isConnectedOverride ( )
protectedpure virtual

Member Data Documentation

BindingProcessorRuntimeContainer kanzi::BindingTargetRuntime::m_processorRuntimes
protected

Binding processors runtimes (for the target, backward direction).

AbstractBindingRuntime* kanzi::BindingTargetRuntime::m_bindingRuntime
protected

Abstract binding runtime for this target.


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