Kanzi  3.9.7
Kanzi Engine API
kanzi::InstructionBindingProcessor Class Reference

Instruction binding processor is the top-level class for all instruction-like binding processors. More...

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

Inheritance diagram for kanzi::InstructionBindingProcessor:
[legend]

Public Member Functions

PropertyField getInputField1 () const
 
PropertyField getInputField2 () const
 
PropertyField getInputField3 () const
 
BindingExpressionArgumentType getInputRegister1Type () const
 Returns The first input register type. More...
 
BindingExpressionArgumentType getInputRegister2Type () const
 
BindingExpressionArgumentType getInputRegister3Type () const
 
PropertyField getOutputField () const
 
unsigned int getOutputRegisterIndex () const
 
void setInputFields (PropertyField field1, PropertyField field2, PropertyField field3)
 Sets the input fields. More...
 
void setInputFields (PropertyField field1, PropertyField field2)
 Sets the first two input fields to property fields field1 and field2, and the third input field to whole property. More...
 
void setInputFields (PropertyField field1)
 Sets the first input field to property field field1, and the second and third input fields to whole property. More...
 
void setInputRegisterTypes (BindingExpressionArgumentType inputRegister1Type, BindingExpressionArgumentType inputRegister2Type, BindingExpressionArgumentType inputRegister3Type)
 Sets the input register types. More...
 
void setInputRegisterTypes (BindingExpressionArgumentType inputRegister1Type, BindingExpressionArgumentType inputRegister2Type)
 Sets the input register types. More...
 
void setInputRegisterTypes (BindingExpressionArgumentType inputRegister1Type)
 Sets the input register types. More...
 
void setOutputField (PropertyField outputField)
 Sets the output field. More...
 
void setOutputRegisterIndex (unsigned int outputRegisterIndex)
 Sets the output register index. More...
 
- Public Member Functions inherited from kanzi::BindingProcessor
BindingProcessorRuntimePtr createRuntime ()
 Creates a runtime for the binding processor. More...
 
virtual ~BindingProcessor ()=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers. More...
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
virtual ~PropertyObject ()
 

Protected Member Functions

BindingProcessorRuntimePtr createRuntimeOverride () override
 BindingProcessor::BindingProcessor() implementation. More...
 
 InstructionBindingProcessor (Domain *domain)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingProcessor
 BindingProcessor (Domain *domain)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
 Notifies all property handlers on a property storage. More...
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers. More...
 

Protected Attributes

PropertyField m_inputField1
 Input range field. More...
 
PropertyField m_inputField2
 Input range field. More...
 
PropertyField m_inputField3
 Input range field. More...
 
BindingExpressionArgumentType m_inputRegister1Type
 Input register type. More...
 
BindingExpressionArgumentType m_inputRegister2Type
 Input register type. More...
 
BindingExpressionArgumentType m_inputRegister3Type
 Input register type. More...
 
PropertyField m_outputField
 Input range field. More...
 
unsigned int m_outputRegisterIndex
 Output register index. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::BindingProcessor
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Detailed Description

Instruction binding processor is the top-level class for all instruction-like binding processors.

Regular instructions in bindings are executed as simple mathematical or logical operations described with the BindingExpressionOpCode struct. Some more complex operations are required to hold an internal state, in which case a simple operation code is not sufficient. When you implement complex custom binding operations, inherit InstructionBindingProcessor.

InstructionBindingProcessor provides the input and output register interface that the inheriting class can use to resolve registers on attach. These resolved registers are then available when the processor is executed.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

kanzi::InstructionBindingProcessor::InstructionBindingProcessor ( Domain domain)
explicitprotected

Constructor.

Parameters
domainDomain to use.

Member Function Documentation

void kanzi::InstructionBindingProcessor::setInputRegisterTypes ( BindingExpressionArgumentType  inputRegister1Type,
BindingExpressionArgumentType  inputRegister2Type,
BindingExpressionArgumentType  inputRegister3Type 
)
inline

Sets the input register types.

Parameters
inputRegister1TypeInput register 1 type.
inputRegister2TypeInput register 2 type.
inputRegister3TypeInput register 3 type.
void kanzi::InstructionBindingProcessor::setInputRegisterTypes ( BindingExpressionArgumentType  inputRegister1Type,
BindingExpressionArgumentType  inputRegister2Type 
)
inline

Sets the input register types.

Third register is omitted.

Parameters
inputRegister1TypeInput register 1 type.
inputRegister2TypeInput register 2 type.
void kanzi::InstructionBindingProcessor::setInputRegisterTypes ( BindingExpressionArgumentType  inputRegister1Type)
inline

Sets the input register types.

Second and third registers are omitted.

Parameters
inputRegister1TypeInput register 1 type.
void kanzi::InstructionBindingProcessor::setInputFields ( PropertyField  field1,
PropertyField  field2,
PropertyField  field3 
)
inline

Sets the input fields.

Parameters
field1Register 1 field.
field2Register 2 field.
field3Register 3 field.
void kanzi::InstructionBindingProcessor::setInputFields ( PropertyField  field1,
PropertyField  field2 
)
inline

Sets the first two input fields to property fields field1 and field2, and the third input field to whole property.

Parameters
field1Register 1 field.
field2Register 2 field.
void kanzi::InstructionBindingProcessor::setInputFields ( PropertyField  field1)
inline

Sets the first input field to property field field1, and the second and third input fields to whole property.

Parameters
field1Register 1 field.
void kanzi::InstructionBindingProcessor::setOutputRegisterIndex ( unsigned int  outputRegisterIndex)
inline

Sets the output register index.

Attaching the processor resolves the register.

Parameters
outputRegisterIndexOutput register index.
void kanzi::InstructionBindingProcessor::setOutputField ( PropertyField  outputField)
inline

Sets the output field.

Parameters
outputFieldOutput field.
BindingExpressionArgumentType kanzi::InstructionBindingProcessor::getInputRegister1Type ( ) const
inline

Returns The first input register type.

Returns
The first input register type.
BindingExpressionArgumentType kanzi::InstructionBindingProcessor::getInputRegister2Type ( ) const
inline
Returns
The second input register type.
BindingExpressionArgumentType kanzi::InstructionBindingProcessor::getInputRegister3Type ( ) const
inline
Returns
The third input register type.
unsigned int kanzi::InstructionBindingProcessor::getOutputRegisterIndex ( ) const
inline
Returns
The third output register index.
PropertyField kanzi::InstructionBindingProcessor::getInputField1 ( ) const
inline
Returns
The first input field.
PropertyField kanzi::InstructionBindingProcessor::getInputField2 ( ) const
inline
Returns
The second input field.
PropertyField kanzi::InstructionBindingProcessor::getInputField3 ( ) const
inline
Returns
The third input field.
PropertyField kanzi::InstructionBindingProcessor::getOutputField ( ) const
inline
Returns
The output field.
BindingProcessorRuntimePtr kanzi::InstructionBindingProcessor::createRuntimeOverride ( )
overrideprotectedvirtual

Member Data Documentation

BindingExpressionArgumentType kanzi::InstructionBindingProcessor::m_inputRegister1Type
protected

Input register type.

PropertyField kanzi::InstructionBindingProcessor::m_inputField1
protected

Input range field.

BindingExpressionArgumentType kanzi::InstructionBindingProcessor::m_inputRegister2Type
protected

Input register type.

PropertyField kanzi::InstructionBindingProcessor::m_inputField2
protected

Input range field.

BindingExpressionArgumentType kanzi::InstructionBindingProcessor::m_inputRegister3Type
protected

Input register type.

PropertyField kanzi::InstructionBindingProcessor::m_inputField3
protected

Input range field.

unsigned int kanzi::InstructionBindingProcessor::m_outputRegisterIndex
protected

Output register index.

PropertyField kanzi::InstructionBindingProcessor::m_outputField
protected

Input range field.


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