Iterator location range pointing to a particular location of an iterator range. More...

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

Inheritance diagram for kanzi::ImmutableIteratorRange:

Public Member Functions
void	advance ()
	Advance the iterator location.

Public Member Functions inherited from kanzi::IteratorRange
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	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 ImmutableIteratorRangeSharedPtr	create (const AbstractRangeIterator &sourceIterator)
	Creates a new iterator range.

Static Public Member Functions inherited from kanzi::IteratorRange
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
AbstractRangeSharedPtr	evaluateOverride () override
	AbstractRange::evaluateOverride() implementation.

	ImmutableIteratorRange (const AbstractRangeIterator &sourceIterator)
	Constructor.

Protected Member Functions inherited from kanzi::IteratorRange
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.

Additional Inherited Members
Public Types inherited from kanzi::IteratorRange
using	const_iterator
	Const iterator type for values.

using	iterator
	Iterator type for values.

Protected Attributes inherited from kanzi::IteratorRange
AbstractRangeIterator	m_iter
	Iterator into a source range.

AbstractRangeSharedPtr	m_sourceRangeReference
	Reference to the source range.

Detailed Description

Iterator location range pointing to a particular location of an iterator range.

As opposed to the iterator range that advances when evaluated, and the first evaluation returns the initial location, evaluating IteratorLocationRange will not modify its own iterator and returns the next element in sequence.

Since: Kanzi 3.9.0

Constructor & Destructor Documentation

◆ ImmutableIteratorRange()

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

explicitprotected

Constructor.

Parameters

sourceIterator Iterator to another range.

Member Function Documentation

◆ create()

static ImmutableIteratorRangeSharedPtr kanzi::ImmutableIteratorRange::create ( const AbstractRangeIterator & sourceIterator )

static

Creates a new iterator range.

Parameters

sourceIterator Iterator to another range.

Returns: Iterator range shared pointer.

◆ advance()

void kanzi::ImmutableIteratorRange::advance ( )

Advance the iterator location.

Called internally by Kanzi after the creation of ImmutableIterationRange as needed.

◆ evaluateOverride()

AbstractRangeSharedPtr kanzi::ImmutableIteratorRange::evaluateOverride ( )

overrideprotectedvirtual

AbstractRange::evaluateOverride() implementation.

Reimplemented from kanzi::AbstractRange.

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

kanzi/core.ui/binding/iterator_range.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions