Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::TypedMessageBindingTargetRuntime< T > Class Template Reference

Typed runtime for message binding target. More...

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

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

Static Public Member Functions

static BindingTargetRuntimePtr create (AbstractPropertyType propertyType, PropertyField field)
 Creates a typed message binding source runtime. More...
 
- Static Public Member Functions inherited from kanzi::MessageBindingTargetRuntime
static BindingTargetRuntimePtr create (AbstractPropertyType propertyType, PropertyField field)
 Creates a message binding target runtime. More...
 

Protected Member Functions

bool readOverride (Variant &value) override
 BindingTargetRuntime::readOverride() implementation. More...
 
 TypedMessageBindingTargetRuntime (AbstractPropertyType propertyType, PropertyField field)
 Constructor. More...
 
bool writeOverride (const Variant &value) override
 BindingTargetRuntime::writeOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::MessageBindingTargetRuntime
void attachForReadOverride () override
 BindingTargetRuntime::attachForReadOverride() implementation. More...
 
void attachForWriteOverride () override
 BindingTargetRuntime::attachForWriteOverride() implementation. More...
 
void detachOverride () override
 BindingTargetRuntime::detachOverride() implementation. More...
 
bool isConnectedOverride () override
 BindingTargetRuntime::isConnectedOverride() implementation. More...
 
 MessageBindingTargetRuntime (AbstractPropertyType propertyType, PropertyField field)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingTargetRuntime
 BindingTargetRuntime ()=default
 Constructor. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::BindingTargetRuntime
using BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator
 Binding processor iterator type. More...
 
using BindingProcessorRuntimeContainer = vector< BindingProcessorRuntimePtr >
 Binding processor container type. More...
 
- Public Member Functions inherited from kanzi::MessageBindingTargetRuntime
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::BindingTargetRuntime
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 Attributes inherited from kanzi::MessageBindingTargetRuntime
PropertyField m_field
 Property field to use. More...
 
MessageArgumentsm_messageArguments
 Message set manually to this message binding source. More...
 
AbstractPropertyType m_propertyType
 Property type to write. More...
 
- Protected Attributes inherited from kanzi::BindingTargetRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this target. More...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors runtimes (for the target, backward direction). More...
 

Detailed Description

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

Typed runtime for message binding target.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

template<typename T >
kanzi::TypedMessageBindingTargetRuntime< T >::TypedMessageBindingTargetRuntime ( AbstractPropertyType  propertyType,
PropertyField  field 
)
inlineexplicitprotected

Constructor.

Parameters
propertyTypeProperty type to use.
fieldProperty field to use.
Since
Kanzi 3.9.6 Removed BindingLookupContext.

Member Function Documentation

template<typename T >
static BindingTargetRuntimePtr kanzi::TypedMessageBindingTargetRuntime< T >::create ( AbstractPropertyType  propertyType,
PropertyField  field 
)
inlinestatic

Creates a typed message binding source runtime.

Parameters
propertyTypeProperty type to use.
fieldProperty field to use.
Returns
The created manual binding source runtime.
Since
Kanzi 3.9.6 Removed BindingLookupContextPtr.
template<typename T >
bool kanzi::TypedMessageBindingTargetRuntime< T >::readOverride ( Variant value)
inlineoverrideprotectedvirtual
template<typename T >
bool kanzi::TypedMessageBindingTargetRuntime< T >::writeOverride ( const Variant value)
inlineoverrideprotectedvirtual

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