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:

Public Member Functions
PropertyField	getInputField1 () const

PropertyField	getInputField2 () const

PropertyField	getInputField3 () const

BindingExpressionArgumentType	getInputRegister1Type () const
	Returns The first input register type.

BindingExpressionArgumentType	getInputRegister2Type () const

BindingExpressionArgumentType	getInputRegister3Type () const

PropertyField	getOutputField () const

unsigned int	getOutputRegisterIndex () const

void	setInputFields (PropertyField field1)
	Sets the first input field to property field field1, and the second and third input fields to whole property.

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.

void	setInputFields (PropertyField field1, PropertyField field2, PropertyField field3)
	Sets the input fields.

void	setInputRegisterTypes (BindingExpressionArgumentType inputRegister1Type)
	Sets the input register types.

void	setInputRegisterTypes (BindingExpressionArgumentType inputRegister1Type, BindingExpressionArgumentType inputRegister2Type)
	Sets the input register types.

void	setInputRegisterTypes (BindingExpressionArgumentType inputRegister1Type, BindingExpressionArgumentType inputRegister2Type, BindingExpressionArgumentType inputRegister3Type)
	Sets the input register types.

void	setOutputField (PropertyField outputField)
	Sets the output field.

void	setOutputRegisterIndex (unsigned int outputRegisterIndex)
	Sets the output register index.

Public Member Functions inherited from kanzi::BindingProcessor
BindingProcessorRuntimePtr	createRuntime ()
	Creates a runtime for the binding processor.

virtual	~BindingProcessor ()=default
	Destructor.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

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

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.

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, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

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.

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.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

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.

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.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Protected Member Functions
BindingProcessorRuntimePtr	createRuntimeOverride () override
	BindingProcessor::BindingProcessor() implementation.

	InstructionBindingProcessor (Domain *domain)
	Constructor.

Protected Member Functions inherited from kanzi::BindingProcessor
	BindingProcessor (Domain *domain)
	Constructor.

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::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (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.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Protected Attributes
PropertyField	m_inputField1
	Input range field.

PropertyField	m_inputField2
	Input range field.

PropertyField	m_inputField3
	Input range field.

BindingExpressionArgumentType	m_inputRegister1Type
	Input register type.

BindingExpressionArgumentType	m_inputRegister2Type
	Input register type.

BindingExpressionArgumentType	m_inputRegister3Type
	Input register type.

PropertyField	m_outputField
	Input range field.

unsigned int	m_outputRegisterIndex
	Output register index.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Additional Inherited Members
Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

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

◆ InstructionBindingProcessor()

kanzi::InstructionBindingProcessor::InstructionBindingProcessor ( Domain * domain )

explicitprotected

Constructor.

Parameters

domain Domain to use.

Member Function Documentation

◆ setInputRegisterTypes() [1/3]

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

inline

Sets the input register types.

Parameters

inputRegister1Type	Input register 1 type.
inputRegister2Type	Input register 2 type.
inputRegister3Type	Input register 3 type.

◆ setInputRegisterTypes() [2/3]

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

inline

Sets the input register types.

Third register is omitted.

Parameters

inputRegister1Type	Input register 1 type.
inputRegister2Type	Input register 2 type.

◆ setInputRegisterTypes() [3/3]

void kanzi::InstructionBindingProcessor::setInputRegisterTypes ( BindingExpressionArgumentType inputRegister1Type )

inline

Sets the input register types.

Second and third registers are omitted.

Parameters

inputRegister1Type Input register 1 type.

◆ setInputFields() [1/3]

void kanzi::InstructionBindingProcessor::setInputFields	(	PropertyField	field1,
		PropertyField	field2,
		PropertyField	field3 )

inline

Sets the input fields.

Parameters

field1	Register 1 field.
field2	Register 2 field.
field3	Register 3 field.

◆ setInputFields() [2/3]

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

field1	Register 1 field.
field2	Register 2 field.

◆ setInputFields() [3/3]

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

field1 Register 1 field.

◆ setOutputRegisterIndex()

void kanzi::InstructionBindingProcessor::setOutputRegisterIndex ( unsigned int outputRegisterIndex )

inline

Sets the output register index.

Attaching the processor resolves the register.

Parameters

outputRegisterIndex Output register index.

◆ setOutputField()

void kanzi::InstructionBindingProcessor::setOutputField ( PropertyField outputField )

inline

Sets the output field.

Parameters

outputField Output field.

◆ getInputRegister1Type()

BindingExpressionArgumentType kanzi::InstructionBindingProcessor::getInputRegister1Type ( ) const

inline

Returns The first input register type.

Returns: The first input register type.

◆ getInputRegister2Type()

BindingExpressionArgumentType kanzi::InstructionBindingProcessor::getInputRegister2Type ( ) const

inline

Returns: The second input register type.

◆ getInputRegister3Type()

BindingExpressionArgumentType kanzi::InstructionBindingProcessor::getInputRegister3Type ( ) const

inline

Returns: The third input register type.

◆ getOutputRegisterIndex()

unsigned int kanzi::InstructionBindingProcessor::getOutputRegisterIndex ( ) const

inline

Returns: The third output register index.

◆ getInputField1()

PropertyField kanzi::InstructionBindingProcessor::getInputField1 ( ) const

inline

Returns: The first input field.

◆ getInputField2()

PropertyField kanzi::InstructionBindingProcessor::getInputField2 ( ) const

inline

Returns: The second input field.

◆ getInputField3()

PropertyField kanzi::InstructionBindingProcessor::getInputField3 ( ) const

inline

Returns: The third input field.

◆ getOutputField()

PropertyField kanzi::InstructionBindingProcessor::getOutputField ( ) const

inline

Returns: The output field.

◆ createRuntimeOverride()

BindingProcessorRuntimePtr kanzi::InstructionBindingProcessor::createRuntimeOverride ( )

overrideprotectedvirtual

BindingProcessor::BindingProcessor() implementation.

Implements kanzi::BindingProcessor.

Reimplemented in kanzi::RangeAccumulateBindingProcessor, kanzi::RangeBindingProcessor, and kanzi::ResourceBindingProcessor.

Member Data Documentation

◆ m_inputRegister1Type

BindingExpressionArgumentType kanzi::InstructionBindingProcessor::m_inputRegister1Type

protected

Input register type.

◆ m_inputField1

PropertyField kanzi::InstructionBindingProcessor::m_inputField1

protected

Input range field.

◆ m_inputRegister2Type

BindingExpressionArgumentType kanzi::InstructionBindingProcessor::m_inputRegister2Type

protected

Input register type.

◆ m_inputField2

PropertyField kanzi::InstructionBindingProcessor::m_inputField2

protected

Input range field.

◆ m_inputRegister3Type

BindingExpressionArgumentType kanzi::InstructionBindingProcessor::m_inputRegister3Type

protected

Input register type.

◆ m_inputField3

PropertyField kanzi::InstructionBindingProcessor::m_inputField3

protected

Input range field.

◆ m_outputRegisterIndex

unsigned int kanzi::InstructionBindingProcessor::m_outputRegisterIndex

protected

Output register index.

◆ m_outputField

PropertyField kanzi::InstructionBindingProcessor::m_outputField

protected

Input range field.

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

kanzi/core.ui/binding/instruction_binding_processor.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InstructionBindingProcessor()

Member Function Documentation

◆ setInputRegisterTypes() [1/3]

◆ setInputRegisterTypes() [2/3]

◆ setInputRegisterTypes() [3/3]

◆ setInputFields() [1/3]

◆ setInputFields() [2/3]

◆ setInputFields() [3/3]

◆ setOutputRegisterIndex()

◆ setOutputField()

◆ getInputRegister1Type()

◆ getInputRegister2Type()

◆ getInputRegister3Type()

◆ getOutputRegisterIndex()

◆ getInputField1()

◆ getInputField2()

◆ getInputField3()

◆ getOutputField()

◆ createRuntimeOverride()

Member Data Documentation

◆ m_inputRegister1Type

◆ m_inputField1

◆ m_inputRegister2Type

◆ m_inputField2

◆ m_inputRegister3Type

◆ m_inputField3

◆ m_outputRegisterIndex

◆ m_outputField