Kanzi  3.9.6
Kanzi Engine API
kanzi::TypedMessageBindingSourceRuntime< T > Class Template Reference

Runtime for message binding source. More...

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

Inheritance diagram for kanzi::TypedMessageBindingSourceRuntime< T >:
[legend]

Static Public Member Functions

static BindingSourceRuntimePtr create (const MessageBindingSource &source, BindingLookupContextPtr lookupContext)
 Creates a typed message binding source runtime. More...
 

Protected Member Functions

bool readOverride (Variant &value) override
 BindingSourceRuntime::readOverride() implementation. More...
 
 TypedMessageBindingSourceRuntime (const MessageBindingSource &source, BindingLookupContextPtr lookupContext)
 Constructor. More...
 
bool writeOverride (const Variant &value) override
 BindingSourceRuntime::writeOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::MessageBindingSourceRuntime
void attachForReadOverride () override
 BindingSourceRuntime::attachForReadOverride() implementation. More...
 
void attachForWriteOverride () override
 BindingSourceRuntime::attachForWriteOverride() implementation. More...
 
void detachOverride () override
 BindingSourceRuntime::detachOverride() implementation. More...
 
bool isConnectedOverride () override
 BindingSourceRuntime::isConnectedOverride() implementation. More...
 
 MessageBindingSourceRuntime (const MessageBindingSource &source, BindingLookupContextPtr lookupContext)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingSourceRuntime
 BindingSourceRuntime (BindingLookupContextPtr lookupContext)
 Constructor. More...
 

Additional Inherited Members

- 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 inherited from kanzi::MessageBindingSourceRuntime
PropertyField getPropertyField () const
 Gets property field. More...
 
AbstractPropertyType getPropertyType () const
 Gets property type. More...
 
void setMessage (MessageArguments *args)
 Sets the message to use for acquiring arguments on update. 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...
 
AbstractBindingRuntimegetBindingRuntime () const
 Returns the source lookup context. More...
 
BindingLookupContextgetLookupContext () 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...
 
- Protected Attributes inherited from kanzi::MessageBindingSourceRuntime
MessageArgumentsm_messageArguments
 Message set manually to this message binding source. More...
 
const MessageBindingSourcem_source
 Host binding source. More...
 
- Protected Attributes inherited from kanzi::BindingSourceRuntime
AbstractBindingRuntimem_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

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

Runtime for message binding source.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

◆ TypedMessageBindingSourceRuntime()

template<typename T >
kanzi::TypedMessageBindingSourceRuntime< T >::TypedMessageBindingSourceRuntime ( const MessageBindingSource source,
BindingLookupContextPtr  lookupContext 
)
inlineexplicitprotected

Constructor.

Parameters
sourceHost object property binding source.
lookupContextLookup context for this binding source runtime.

Member Function Documentation

◆ create()

template<typename T >
static BindingSourceRuntimePtr kanzi::TypedMessageBindingSourceRuntime< T >::create ( const MessageBindingSource source,
BindingLookupContextPtr  lookupContext 
)
inlinestatic

Creates a typed message binding source runtime.

Parameters
sourceHost object property binding source.
lookupContextLookup context for this binding source runtime.
Returns
The manual binding source runtime.

◆ readOverride()

template<typename T >
bool kanzi::TypedMessageBindingSourceRuntime< T >::readOverride ( Variant value)
inlineoverrideprotectedvirtual

◆ writeOverride()

template<typename T >
bool kanzi::TypedMessageBindingSourceRuntime< T >::writeOverride ( const Variant value)
inlineoverrideprotectedvirtual

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