Kanzi  3.9.4
Kanzi Engine API
kanzi::MessageBindingSourceRuntime Class Reference

Runtime for message binding source. More...

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

Inheritance diagram for kanzi::MessageBindingSourceRuntime:
[legend]

Public Member Functions

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 Member Functions

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...
 
virtual bool readOverride (Variant &value)=0
 Implementation-dependent read. More...
 
virtual bool writeOverride (const Variant &value)
 Implementation-dependent write. More...
 

Protected Attributes

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

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

Detailed Description

Runtime for message binding source.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

◆ MessageBindingSourceRuntime()

kanzi::MessageBindingSourceRuntime::MessageBindingSourceRuntime ( const MessageBindingSource source,
BindingLookupContextPtr  lookupContext 
)
inlineexplicitprotected

Constructor.

Parameters
sourceHost message binding source.
lookupContextLookup context for this binding source runtime.

Member Function Documentation

◆ getPropertyType()

AbstractPropertyType kanzi::MessageBindingSourceRuntime::getPropertyType ( ) const

Gets property type.

Returns
Property type for this source runtime.

◆ getPropertyField()

PropertyField kanzi::MessageBindingSourceRuntime::getPropertyField ( ) const

Gets property field.

Returns
Property field for this source runtime.

◆ setMessage()

void kanzi::MessageBindingSourceRuntime::setMessage ( MessageArguments args)
inline

Sets the message to use for acquiring arguments on update.

Parameters
argsMessage arguments to use.

◆ attachForReadOverride()

void kanzi::MessageBindingSourceRuntime::attachForReadOverride ( )
overrideprotectedvirtual

◆ attachForWriteOverride()

void kanzi::MessageBindingSourceRuntime::attachForWriteOverride ( )
overrideprotectedvirtual

◆ detachOverride()

void kanzi::MessageBindingSourceRuntime::detachOverride ( )
overrideprotectedvirtual

◆ isConnectedOverride()

bool kanzi::MessageBindingSourceRuntime::isConnectedOverride ( )
overrideprotectedvirtual

Member Data Documentation

◆ m_messageArguments

MessageArguments* kanzi::MessageBindingSourceRuntime::m_messageArguments
protected

Message set manually to this message binding source.

◆ m_source

const MessageBindingSource& kanzi::MessageBindingSourceRuntime::m_source
protected

Host binding source.


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