kanzi::RangeBindingProcessor Class Reference

Range binding processor is a binding processor for accessing ranges from range producers. More...

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

Inheritance diagram for kanzi::RangeBindingProcessor:

Public Member Functions
ValueRangeSharedPtr	getValueRange () const
	Accesses the range contained in this range processor. More...
bool	matches (string_view identifier, string_view params) const
	Indicates whether the iterator processor matches given settings. More...
void	rangeNotify ()
	Notify operation for the range. More...
	~RangeBindingProcessor () override
	Destructor. 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 ()
Public Member Functions inherited from kanzi::BindingLookupNotificationBase
void	clearLocalNotificationFlag ()
	Clears local notification flag. More...
bool	isGlobalNotificationInstalled () const
	Tells if this a global notification has been registered. More...
bool	isLocalNotificationInstalled () const
	Tells if this a local notification has been registered. More...
void	registerGlobalNotification (BindingLookupContext &lookupContext, string_view path)
	Installs a global notification listener. More...
void	registerLocalNotification (BindingLookupContext &lookupContext, PropertyObject &object, string_view path)
	Installs a local notification listener. More...
void	unregisterGlobalNotification (BindingLookupContext &lookupContext, string_view path)
	Uninstalls a global notification listener. More...
void	unregisterLocalNotification (BindingLookupContext &lookupContext, PropertyObject &object, string_view path)
	Uninstalls a local notification listener. More...
	~BindingLookupNotificationBase ()
	Destructor. More...
Public Member Functions inherited from kanzi::RangeAccessBindingConcept
size_t	getLength ()
	Gets the length of the range. More...
Variant *	getWriteRegister (size_t index)
	Accesses a register for writing by index. More...
bool	readValue (Variant &value, size_t index)
	Reads a value from range by index. More...

Static Public Member Functions
static RangeBindingProcessorSharedPtr	create (Domain *domain, string_view path, string_view params, size_t length)
	Creates a range binding processor. More...
static RangeBindingProcessorSharedPtr	create (Domain *domain, string_view path, string_view params)
	Creates a range binding processor. More...
static RangeBindingProcessorSharedPtr	create (Domain *domain, string_view name)
	Default create implementation. 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...
size_t	getLengthOverride () override
	RangeAccessBindingConcept::getLengthOverride() implementation. More...
void	initializePath (string_view name)
	Initialize the path and identifier components of the name. More...
void	onAttach () override
	BindingProcessor::onAttach() implementation. More...
void	onCopy (const BindingProcessor &other) override
	BindingProcessor::onDetach() implementation. More...
void	onDetach () override
	BindingProcessor::onDetach() implementation. More...
void	onGlobalLookupNotification () override
	BindingLookupNotificationImpl::onGlobalLookupNotification() implementation. More...
void	onLocalLookupNotification () override
	BindingLookupNotificationImpl::onLocalLookupNotification() implementation. More...
bool	onValidate (Variant &value) override
	BindingProcessor::onValidate() implementation. More...
	RangeBindingProcessor (Domain *domain, string_view name, string_view params, size_t length)
	Constructor. More...
void	rangeClear ()
	Clear the iterator and remove any notifications. More...
bool	readValueOverride (Variant &value, size_t index) override
	RangeAccessBindingConcept::readValueOverride() implementation. More...
Protected Member Functions inherited from kanzi::BindingProcessor
	BindingProcessor (Domain *domain)
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 Member Functions inherited from kanzi::BindingLookupNotificationBase
	BindingLookupNotificationBase ()
	Constructor. More...
Protected Member Functions inherited from kanzi::RangeAccessBindingConcept
virtual Variant *	getWriteRegisterOverride (size_t index)
	Implementation-specific access to a writable register. More...

Protected Attributes
string_view	m_identifier
	Identifier component of the name, may be empty. More...
size_t	m_length
	Length of the range. More...
string	m_name
	Name component containing the path and identifier. More...
string	m_params
	Iterator lookup parameters. More...
string_view	m_path
	Path component of the name. More...
ValueRangeSharedPtr	m_range
	Iterator being evaluated. More...
ObjectWeakPtr	m_rangeHostObject
	Host object the iterator was acquired from. 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...
Protected Attributes inherited from kanzi::BindingLookupNotificationBase
bool	m_globalNotificationInstalled
	Is the global notification listener installed? More...
bool	m_localNotificationInstalled
	Is the local notification listener installed? 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

Range binding processor is a binding processor for accessing ranges from range producers.

This class provides a mechanism for range lookup and matching with existing binding processors that already have ranges.

Binding processors that implement range instructions refer to the ranges by index of the processor within the same binding. These include:

• RangeAccumulateBindingProcessor
• RangeForEachBindingProcessor
• RangeSpillBindingProcessor

The range operations can only access binding processors that realize the range access interface, which allows reading and potentially writing into ranges:

• RangeAccessBindingConcept

These binding processors implement the range access interface:

• RangeBindingProcessor
• RangeStorageBindingProcessor

Since

Kanzi 3.9.0

Constructor & Destructor Documentation

kanzi::RangeBindingProcessor::~RangeBindingProcessor ( )

override

Destructor.

kanzi::RangeBindingProcessor::RangeBindingProcessor ( Domain *  domain, string_view  name, string_view  params, size_t  length  )

explicitprotected

Constructor.

Parameters

domain	Domain to use.
name	Iterator name.
params	Parameters for iterator creation.
length	Length of the range to access.

Member Function Documentation

static PropertyTypeEditorInfoSharedPtr kanzi::RangeBindingProcessor::makeEditorInfo ( )

static

static RangeBindingProcessorSharedPtr kanzi::RangeBindingProcessor::create ( Domain *  domain, string_view  path, string_view  params, size_t  length  )

static

Creates a range binding processor.

Parameters

domain	Domain to use.
path	Path to use.
params	Parameters for iterator creation.
length	Length of the range to access.

Returns

Range binding processor.

static RangeBindingProcessorSharedPtr kanzi::RangeBindingProcessor::create ( Domain *  domain, string_view  path, string_view  params  )

inlinestatic

Creates a range binding processor.

The range has no set length.

Parameters

domain	Domain to use.
path	Path to use.
params	Parameters for iterator creation.

Returns

Range binding processor.

static RangeBindingProcessorSharedPtr kanzi::RangeBindingProcessor::create ( Domain *  domain, string_view  name  )

static

Default create implementation.

Parameters

domain	Domain.
name	Processor name.

Returns

Range binding processor.

ValueRangeSharedPtr kanzi::RangeBindingProcessor::getValueRange ( ) const

inline

Accesses the range contained in this range processor.

Returns

Value range.

bool kanzi::RangeBindingProcessor::matches	(	string_view	identifier,
		string_view	params
	)		const

Indicates whether the iterator processor matches given settings.

Parameters

identifier	Identifier associated with the iterator. May be empty.
params	Parameters for iterator creation.

Returns

If the iterator processor matches the settings, true, otherwise false.

void kanzi::RangeBindingProcessor::rangeNotify

(

)

Notify operation for the range.

This function is called internally by Kanzi when the range has become invalid or has changed. Calling this function causes the binding containing the range to be re-evaluated if the range is still valid. If the range is no longer valid, it causes a new lookup by the processor using current lookup context.

void kanzi::RangeBindingProcessor::initializePath ( string_view  name )

protected

Initialize the path and identifier components of the name.

Parameters

name	Full name element for parsing the path and the identifier.

void kanzi::RangeBindingProcessor::rangeClear ( )

protected

Clear the iterator and remove any notifications.

void kanzi::RangeBindingProcessor::onAttach ( )

overrideprotectedvirtual

BindingProcessor::onAttach() implementation.

Reimplemented from kanzi::BindingProcessor.

void kanzi::RangeBindingProcessor::onDetach ( )

overrideprotectedvirtual

BindingProcessor::onDetach() implementation.

Reimplemented from kanzi::BindingProcessor.

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

overrideprotectedvirtual

BindingProcessor::onDetach() implementation.

Reimplemented from kanzi::BindingProcessor.

BindingProcessorSharedPtr kanzi::RangeBindingProcessor::clone ( ) const

overrideprotectedvirtual

BindingProcessor::clone() implementation.

Implements kanzi::BindingProcessor.

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

overrideprotectedvirtual

BindingProcessor::onValidate() implementation.

Implements kanzi::BindingProcessor.

void kanzi::RangeBindingProcessor::onGlobalLookupNotification ( )

overrideprotectedvirtual

BindingLookupNotificationImpl::onGlobalLookupNotification() implementation.

Implements kanzi::BindingLookupNotificationBase.

void kanzi::RangeBindingProcessor::onLocalLookupNotification ( )

overrideprotectedvirtual

BindingLookupNotificationImpl::onLocalLookupNotification() implementation.

Implements kanzi::BindingLookupNotificationBase.

size_t kanzi::RangeBindingProcessor::getLengthOverride ( )

overrideprotectedvirtual

RangeAccessBindingConcept::getLengthOverride() implementation.

Implements kanzi::RangeAccessBindingConcept.

bool kanzi::RangeBindingProcessor::readValueOverride ( Variant &  value, size_t  index  )

overrideprotectedvirtual

RangeAccessBindingConcept::readValueOverride() implementation.

Implements kanzi::RangeAccessBindingConcept.

Member Data Documentation

string kanzi::RangeBindingProcessor::m_name

protected

Name component containing the path and identifier.

string_view kanzi::RangeBindingProcessor::m_path

protected

Path component of the name.

string_view kanzi::RangeBindingProcessor::m_identifier

protected

Identifier component of the name, may be empty.

string kanzi::RangeBindingProcessor::m_params

protected

Iterator lookup parameters.

size_t kanzi::RangeBindingProcessor::m_length

protected

Length of the range.

This affects the amount of elements to extract from the range. The actual amount of values may be smaller, in which case the range is expected to provide reasonable default values.

ValueRangeSharedPtr kanzi::RangeBindingProcessor::m_range

protected

Iterator being evaluated.

ObjectWeakPtr kanzi::RangeBindingProcessor::m_rangeHostObject

protected

Host object the iterator was acquired from.

---

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

• kanzi/core.ui/binding/range_binding_processor.hpp