Iterator is an range that references a location in another range. More...

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

Inheritance diagram for kanzi::IteratorRange:

Classes
class	IteratorRangeLocation
	Location implementation for iterator range. More...

Public Types
using	const_iterator
	Const iterator type for values.

using	iterator
	Iterator type for values.

Public Member Functions
void	adapt (AbstractRange &range)
	Adapt another range.

PropertyObjectSharedPtr	getPropertyObject ()
	Gets a property object from the current iterator location.

bool	getPropertyValue (AbstractPropertyType propertyType, Variant &value)
	Gets a property value from the property object at current location.

bool	getValue (Variant &value)
	Gets the value at current location.

Public Member Functions inherited from kanzi::AbstractIndexedRange
PropertyObjectSharedPtr	getPropertyObjectByIndex (size_t index)
	Gets a property object by index.

bool	getPropertyValueByIndex (size_t index, AbstractPropertyType propertyType, Variant &value)
	Access a property in a property object at an index.

size_t	getSize ()
	Gets the size of the indexed range.

bool	getValueByIndex (size_t index, Variant &value)
	Reads a value by index and writes it to a variant.

Public Member Functions inherited from kanzi::AbstractRange
bool	adaptView (AbstractRange &potentialViewRange, size_t length)
	Attempts to reuse a view over this range.

AbstractRangeIterator	beginIteration ()
	Gets an iterator to the beginning of this range.

AbstractRangeSharedPtr	clone ()
	Creates a copy of the range.

void	cloneInto (AbstractRangeSharedPtr &other)
	Clones the range into another range.

AbstractRangeSharedPtr	createView (size_t length)
	Creates a view over this range.

AbstractRangeSharedPtr	evaluate ()
	Evaluate the abstract range.

AbstractRangeLocationPtr	locationBegin ()
	Gets an iteratable location to beginning of the range.

virtual	~AbstractRange ()=default
	Destructor.

Static Public Member Functions
static IteratorRangeSharedPtr	create (AbstractRangeIterator &&sourceIterator)
	Creates a new iterator range.

static IteratorRangeSharedPtr	create (AbstractRangeSharedPtr sourceRange)
	Creates a new iterator range.

static IteratorRangeSharedPtr	create (const AbstractRangeIterator &sourceIterator)
	Creates a new iterator range.

Protected Member Functions
void	cloneIntoOverride (AbstractRangeSharedPtr &other) override
	AbstractRange::cloneIntoOverride() implementation.

AbstractRangeSharedPtr	cloneOverride () override
	AbstractRange::cloneOverride() implementation.

AbstractRangeSharedPtr	evaluateOverride () override
	AbstractRange::evaluateOverride() implementation.

PropertyObjectSharedPtr	getPropertyObjectByIndexOverride (size_t index) override
	AbstractIndexedRange::getPropertyObjectByIndexOverride() implementation.

bool	getPropertyValueByIndexOverride (size_t index, AbstractPropertyType propertyType, Variant &value) override
	AbstractIndexedRange::getPropertyValueByIndexOverride() implementation.

size_t	getSizeOverride () override
	AbstractIndexedRange::getSizeOverride() implementation.

bool	getValueByIndexOverride (size_t index, Variant &value) override
	AbstractIndexedRange::getValueByIndexOverride() implementation.

	IteratorRange (AbstractRangeIterator &&sourceIterator)
	Constructor.

	IteratorRange (const AbstractRangeIterator &sourceIterator)
	Constructor.

AbstractRangeLocationPtr	locationBeginOverride () override
	AbstractRange::locationBeginOverride() implementation.

Protected Member Functions inherited from kanzi::AbstractIndexedRange
bool	adaptViewOverride (AbstractRange &potentialViewRange, size_t length) override
	AbstractRange::adaptViewOverride() implementation.

AbstractRangeSharedPtr	createViewOverride (size_t length) override
	AbstractRange::createViewOverride() implementation.

Protected Member Functions inherited from kanzi::AbstractRange
	AbstractRange ()=default
	Constructor.

Protected Attributes
AbstractRangeIterator	m_iter
	Iterator into a source range.

AbstractRangeSharedPtr	m_sourceRangeReference
	Reference to the source range.

Detailed Description

Iterator is an range that references a location in another range.

Iterator range combines a weak reference to another range and an iterator to that range. There is only one readable value, which is the current iteration location.

Evaluating the iterator range yields a new iterator range that advances the iterator one step. If the iteration has already reached the end of the source range, the evaluation returns a shared pointer to the same range (the same as default result of range evaluation).

Since: Kanzi 3.9.0

Member Typedef Documentation

◆ iterator

using kanzi::IteratorRange::iterator

Iterator type for values.

◆ const_iterator

using kanzi::IteratorRange::const_iterator

Const iterator type for values.

Constructor & Destructor Documentation

◆ IteratorRange() [1/2]

kanzi::IteratorRange::IteratorRange ( const AbstractRangeIterator & sourceIterator )

explicitprotected

Constructor.

Parameters

sourceIterator Iterator to another range.

◆ IteratorRange() [2/2]

kanzi::IteratorRange::IteratorRange ( AbstractRangeIterator && sourceIterator )

explicitprotected

Constructor.

Parameters

sourceIterator Iterator to another range.

Member Function Documentation

◆ create() [1/3]

static IteratorRangeSharedPtr kanzi::IteratorRange::create ( AbstractRangeSharedPtr sourceRange )

static

Creates a new iterator range.

Parameters

sourceRange Range to iterate.

Returns: Iterator range shared pointer.

◆ create() [2/3]

static IteratorRangeSharedPtr kanzi::IteratorRange::create ( const AbstractRangeIterator & sourceIterator )

static

Creates a new iterator range.

Parameters

sourceIterator Source iterator to advance.

Returns: Iterator range shared pointer.

◆ create() [3/3]

static IteratorRangeSharedPtr kanzi::IteratorRange::create ( AbstractRangeIterator && sourceIterator )

static

Creates a new iterator range.

Parameters

sourceIterator Source iterator to advance.

Returns: Iterator range shared pointer.

◆ getPropertyObject()

PropertyObjectSharedPtr kanzi::IteratorRange::getPropertyObject ( )

inline

Gets a property object from the current iterator location.

Returns: Property object at current location or nullptr

◆ getPropertyValue()

bool kanzi::IteratorRange::getPropertyValue	(	AbstractPropertyType	propertyType,
		Variant &	value )

inline

Gets a property value from the property object at current location.

Parameters

propertyType	Property type to acquire.
value	Variant to store the value into.

Returns: If a property value was extracted, true, otherwise false.

◆ getValue()

bool kanzi::IteratorRange::getValue ( Variant & value )

inline

Gets the value at current location.

Parameters

value Variant to store the value into.

Returns: If a value was extracted, true, otherwise false.

◆ adapt()

void kanzi::IteratorRange::adapt ( AbstractRange & range )

inline

Adapt another range.

This function is used internally by Kanzi to reuse an IteratorRange as opposed to creating a new one.

Parameters

range Range to adapt.

◆ cloneOverride()

AbstractRangeSharedPtr kanzi::IteratorRange::cloneOverride ( )

overrideprotectedvirtual

AbstractRange::cloneOverride() implementation.

Implements kanzi::AbstractRange.

◆ cloneIntoOverride()

void kanzi::IteratorRange::cloneIntoOverride ( AbstractRangeSharedPtr & other )

overrideprotectedvirtual

AbstractRange::cloneIntoOverride() implementation.

Implements kanzi::AbstractRange.

◆ evaluateOverride()

AbstractRangeSharedPtr kanzi::IteratorRange::evaluateOverride ( )

overrideprotectedvirtual

AbstractRange::evaluateOverride() implementation.

Reimplemented from kanzi::AbstractRange.

◆ locationBeginOverride()

AbstractRangeLocationPtr kanzi::IteratorRange::locationBeginOverride ( )

overrideprotectedvirtual

AbstractRange::locationBeginOverride() implementation.

Implements kanzi::AbstractRange.

◆ getSizeOverride()

size_t kanzi::IteratorRange::getSizeOverride ( )

overrideprotectedvirtual

AbstractIndexedRange::getSizeOverride() implementation.

Implements kanzi::AbstractIndexedRange.

◆ getPropertyObjectByIndexOverride()

PropertyObjectSharedPtr kanzi::IteratorRange::getPropertyObjectByIndexOverride ( size_t index )

overrideprotectedvirtual

AbstractIndexedRange::getPropertyObjectByIndexOverride() implementation.

Implements kanzi::AbstractIndexedRange.

◆ getPropertyValueByIndexOverride()

bool kanzi::IteratorRange::getPropertyValueByIndexOverride	(	size_t	index,
		AbstractPropertyType	propertyType,
		Variant &	value )

overrideprotectedvirtual

AbstractIndexedRange::getPropertyValueByIndexOverride() implementation.

Implements kanzi::AbstractIndexedRange.

◆ getValueByIndexOverride()

bool kanzi::IteratorRange::getValueByIndexOverride	(	size_t	index,
		Variant &	value )

overrideprotectedvirtual

AbstractIndexedRange::getValueByIndexOverride() implementation.

Implements kanzi::AbstractIndexedRange.

Member Data Documentation

◆ m_iter

AbstractRangeIterator kanzi::IteratorRange::m_iter

protected

Iterator into a source range.

◆ m_sourceRangeReference

AbstractRangeSharedPtr kanzi::IteratorRange::m_sourceRangeReference

protected

Reference to the source range.

AbstractRangeIterator does not hold a reference to the source range, so it falls to the IteratorRange.

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

kanzi/core.ui/binding/iterator_range.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ iterator

◆ const_iterator

Constructor & Destructor Documentation

◆ IteratorRange() [1/2]

◆ IteratorRange() [2/2]

Member Function Documentation

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ getPropertyObject()

◆ getPropertyValue()

◆ getValue()

◆ adapt()

◆ cloneOverride()

◆ cloneIntoOverride()

◆ evaluateOverride()

◆ locationBeginOverride()

◆ getSizeOverride()

◆ getPropertyObjectByIndexOverride()

◆ getPropertyValueByIndexOverride()

◆ getValueByIndexOverride()

Member Data Documentation

◆ m_iter

◆ m_sourceRangeReference