Runs a binary operation for each value in a range in sequence. More...

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

Inheritance diagram for kanzi::RangeAccumulateBindingProcessor:

Public Member Functions
KzuExpressionValidatorOperation	getOperation () const
	Gets the expression operation used for accumulate. More...

void	setOperation (KzuExpressionValidatorOperation operation)
	Sets the expression operation for accumulate. More...

Public Member Functions inherited from kanzi::InstructionBindingProcessor
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
void	attach (AbstractBindingRuntime &bindingRuntime, BindingLookupContext &lookupContext)
	Attach binding processor. More...

BindingProcessorSharedPtr	copy ()
	Creates a copy the binding processor. More...

void	detach ()
	Detach binding processor. More...

void	reattach ()
	Reattach a binding processor to the rule it already was in. More...

bool	validate (Variant &value)
	Validates binding processor. 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...

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

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

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

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

ResourceManager *	getResourceManager () 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	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 ()

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)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Static Public Member Functions
static RangeAccumulateBindingProcessorSharedPtr	create (Domain *domain, string_view name)
	Creates a range accumulate binding processor. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	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 Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

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

Protected Member Functions
BindingProcessorSharedPtr	clone () const override
	BindingProcessor::clone() implementation. More...

void	onCopy (const BindingProcessor &other) override
	BindingProcessor::onCopy() implementation. More...

bool	onValidate (Variant &value) override
	BindingProcessor::onValidate() implementation. More...

	RangeAccumulateBindingProcessor (Domain *domain)
	Constructor. More...

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

void	onAttach () override
	BindingProcessor::onAttach() implementation. More...

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

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

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

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

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

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

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

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

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

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

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	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Protected Attributes
BindingExpressionFunction	m_expressionFunction
	Expression function for the operation. More...

KzuExpressionValidatorOperation	m_operation
	Expression operation. More...

Protected Attributes inherited from kanzi::InstructionBindingProcessor
PropertyField	m_inputField1
	Input range field. More...

PropertyField	m_inputField2
	Input range field. More...

PropertyField	m_inputField3
	Input range field. More...

Variant *	m_inputRegister1
	Attached input register. More...

BindingExpressionArgumentType	m_inputRegister1Type
	Input register type. More...

Variant *	m_inputRegister2
	Attached input register. More...

BindingExpressionArgumentType	m_inputRegister2Type
	Input register type. More...

Variant *	m_inputRegister3
	Attached input register. More...

BindingExpressionArgumentType	m_inputRegister3Type
	Input register type. More...

PropertyField	m_outputField
	Input range field. More...

Variant *	m_outputRegister
	Attached output register. More...

unsigned int	m_outputRegisterIndex
	Output register index. More...

Protected Attributes inherited from kanzi::BindingProcessor
AbstractBindingRuntime *	m_bindingRuntime
	The binding runtime to which this processor is attached. More...

BindingLookupContext *	m_lookupContext
	Binding lookup context for the processor. 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< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

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

Static Protected Member Functions inherited from kanzi::BindingProcessor
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Detailed Description

Runs a binary operation for each value in a range in sequence.

RangeAccumulateBindingProcessor is used to run an accumulating operation for every element of the range in sequence, and writing the result into a register.

RangeAccumulateBindingProcessor runs the operation initially on the first two elements, and after that on the result adding from the right. If the range has only one element, RangeAccumulateBindingProcessor returns it as is.

For example, a range operation of + ran on a range of length 5 results in this sequence:

result = ((((range[0] + range[1]) + range[2]) + range[3]) + range[4])

RangeAccumulateBindingProcessor must target another accessible range and write to a register.

Since: Kanzi 3.9.0

Constructor & Destructor Documentation

◆ RangeAccumulateBindingProcessor()

kanzi::RangeAccumulateBindingProcessor::RangeAccumulateBindingProcessor ( Domain * domain )

explicitprotected

Constructor.

Parameters

domain Domain to use.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::RangeAccumulateBindingProcessor::makeEditorInfo ( )

static

◆ create()

static RangeAccumulateBindingProcessorSharedPtr kanzi::RangeAccumulateBindingProcessor::create	(	Domain *	domain,
		string_view	name
	)

static

Creates a range accumulate binding processor.

Parameters

domain	Domain to use.
name	Processor name.

Returns: Range accumulate binding processor.

◆ getOperation()

KzuExpressionValidatorOperation kanzi::RangeAccumulateBindingProcessor::getOperation ( ) const

inline

Gets the expression operation used for accumulate.

Returns: Expression operation.

◆ setOperation()

void kanzi::RangeAccumulateBindingProcessor::setOperation ( KzuExpressionValidatorOperation operation )

Sets the expression operation for accumulate.

Parameters

operation Operation to use.

◆ clone()

BindingProcessorSharedPtr kanzi::RangeAccumulateBindingProcessor::clone ( ) const

overrideprotectedvirtual

BindingProcessor::clone() implementation.

Implements kanzi::BindingProcessor.

◆ onCopy()

void kanzi::RangeAccumulateBindingProcessor::onCopy ( const BindingProcessor & other )

overrideprotectedvirtual

BindingProcessor::onCopy() implementation.

Reimplemented from kanzi::InstructionBindingProcessor.

◆ onValidate()

bool kanzi::RangeAccumulateBindingProcessor::onValidate ( Variant & value )

overrideprotectedvirtual

BindingProcessor::onValidate() implementation.

Implements kanzi::BindingProcessor.

Member Data Documentation

◆ m_operation

KzuExpressionValidatorOperation kanzi::RangeAccumulateBindingProcessor::m_operation

protected

Expression operation.

◆ m_expressionFunction

BindingExpressionFunction kanzi::RangeAccumulateBindingProcessor::m_expressionFunction

protected

Expression function for the operation.

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

kanzi/core.ui/binding/range_accumulate_binding_processor.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RangeAccumulateBindingProcessor()

Member Function Documentation

◆ makeEditorInfo()

◆ create()

◆ getOperation()

◆ setOperation()

◆ clone()

◆ onCopy()

◆ onValidate()

Member Data Documentation

◆ m_operation

◆ m_expressionFunction