Kanzi  3.9.4
Kanzi Engine API
kanzi::TypedManualBindingTargetRuntime< T > Class Template Reference

Typed runtime for manual binding target. More...

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

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

Static Public Member Functions

static BindingTargetRuntimePtr create (BindingLookupContextPtr lookupContext, string_view path, AbstractPropertyType propertyType, PropertyField field)
 Creates a typed manual binding target runtime. More...
 
- Static Public Member Functions inherited from kanzi::ManualBindingTargetRuntime
static BindingTargetRuntimePtr create (BindingLookupContextPtr lookupContext, string_view path, AbstractPropertyType propertyType, PropertyField field)
 Creates a manual binding target runtime. More...
 

Protected Member Functions

bool readOverride (Variant &value) override
 BindingTargetRuntime::readOverride() implementation. More...
 
 TypedManualBindingTargetRuntime (BindingLookupContextPtr lookupContext, string_view path, AbstractPropertyType propertyType, PropertyField field)
 Constructor. More...
 
bool writeOverride (const Variant &value) override
 BindingTargetRuntime::writeOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::ManualBindingTargetRuntime
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...
 
 ManualBindingTargetRuntime (BindingLookupContextPtr lookupContext, string_view path, AbstractPropertyType propertyType, PropertyField field)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingTargetRuntime
 BindingTargetRuntime (BindingLookupContextPtr lookupContext)
 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::ManualBindingTargetRuntime
string getPath () const
 Gets path to object. More...
 
PropertyField getPropertyField () const
 Gets property type. More...
 
AbstractPropertyType getPropertyType () const
 Gets property type. 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
 Accesses target 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::ManualBindingTargetRuntime
PropertyField m_field
 Property field written. More...
 
string m_path
 Path to target object. More...
 
AbstractPropertyType m_propertyType
 Property type written. More...
 
- Protected Attributes inherited from kanzi::BindingTargetRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this target. More...
 
BindingLookupContextPtr m_lookupContext
 Binding lookup context for wherever this binding target runtime is attached to. More...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors runtimes (for the target, backward direction). More...
 

Detailed Description

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

Typed runtime for manual binding target.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

◆ TypedManualBindingTargetRuntime()

template<typename T >
kanzi::TypedManualBindingTargetRuntime< T >::TypedManualBindingTargetRuntime ( BindingLookupContextPtr  lookupContext,
string_view  path,
AbstractPropertyType  propertyType,
PropertyField  field 
)
inlineprotected

Constructor.

Parameters
lookupContextBinding lookup context to use.
pathTarget object path.
propertyTypeTarget property type.
fieldTarget property field.

Member Function Documentation

◆ create()

template<typename T >
static BindingTargetRuntimePtr kanzi::TypedManualBindingTargetRuntime< T >::create ( BindingLookupContextPtr  lookupContext,
string_view  path,
AbstractPropertyType  propertyType,
PropertyField  field 
)
inlinestatic

Creates a typed manual binding target runtime.

Parameters
lookupContextLookup context for this binding target runtime.
pathTarget object path.
propertyTypeTarget property type.
fieldTarget property field.
Returns
The created manual binding target runtime.

◆ readOverride()

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

◆ writeOverride()

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

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