Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::AbstractRangeIterator Class Reference

Abstract range iterator interface. More...

#include <kanzi/core/property/abstract_range.hpp>

Public Member Functions

 AbstractRangeIterator ()=default
 Default constructor. More...
 
 AbstractRangeIterator (AbstractRangeLocationPtr location)
 Constructor. More...
 
 AbstractRangeIterator (AbstractIndexedRange &range)
 Constructor. More...
 
 AbstractRangeIterator (AbstractRange &range)
 Constructor. More...
 
 AbstractRangeIterator (const AbstractRangeIterator &other)
 Copy constructor. More...
 
 AbstractRangeIterator (AbstractRangeIterator &&other) noexcept
 Move constructor. More...
 
bool advance ()
 Advances the iterator. More...
 
PropertyObjectSharedPtr getPropertyObject ()
 Access to a property object at the iterator location. More...
 
bool getPropertyValue (AbstractPropertyType propertyType, Variant &value)
 Access a property at the iterator location. More...
 
AbstractRangegetRange () const
 Accesses the shared range being iterated. More...
 
bool getValue (Variant &value)
 Access a value from a location. More...
 
bool isValid () const
 Indicates whether the iterator is valid. More...
 
 operator bool () const
 Operator for checking if the iterator has been initialized. More...
 
bool operator!= (const AbstractRangeIterator &rhs) const
 Not equals operator. More...
 
AbstractRangeIteratoroperator= (const AbstractRangeIterator &other)
 Copy operator. More...
 
AbstractRangeIteratoroperator= (AbstractRangeIterator &&other) noexcept
 Move operator. More...
 
bool operator== (const AbstractRangeIterator &rhs) const
 Equals operator. More...
 

Protected Attributes

size_t m_index
 Index of the iteration. More...
 
AbstractIndexedRangem_indexedRange
 Reference to indexed range. More...
 
AbstractRangeLocationPtr m_location
 Location in this iterator. More...
 
size_t m_size
 Size of the indexed range. More...
 

Detailed Description

Abstract range iterator interface.

Range iterators are value types, so the virtual access to the range is implemented through range location. If the range becomes invalid, the iterator is also no longer valid.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

kanzi::AbstractRangeIterator::AbstractRangeIterator ( )
explicitdefault

Default constructor.

Constructs an invalid iterator. Functions should not be called.

kanzi::AbstractRangeIterator::AbstractRangeIterator ( AbstractRangeLocationPtr  location)
inlineexplicit

Constructor.

Parameters
locationRange location.
kanzi::AbstractRangeIterator::AbstractRangeIterator ( AbstractIndexedRange range)
inlineexplicit

Constructor.

Parameters
rangeReference to an indexed range.
kanzi::AbstractRangeIterator::AbstractRangeIterator ( AbstractRange range)
inlineexplicit

Constructor.

Parameters
rangeRange to iterate.
kanzi::AbstractRangeIterator::AbstractRangeIterator ( const AbstractRangeIterator other)
inline

Copy constructor.

Parameters
otherSource iterator.
kanzi::AbstractRangeIterator::AbstractRangeIterator ( AbstractRangeIterator &&  other)
inlinenoexcept

Move constructor.

Parameters
otherSource iterator location.

Member Function Documentation

AbstractRange* kanzi::AbstractRangeIterator::getRange ( ) const
inline

Accesses the shared range being iterated.

Only returns a meaningful pointer if the iterator is valid.

Returns
Pointer to iterated range.
bool kanzi::AbstractRangeIterator::isValid ( ) const
inline

Indicates whether the iterator is valid.

If the location has not been set, an iterator is not valid. A iterator is valid if it's not at the end of iteration and can be read.

Returns
If the location is valid, true, false otherwise.
bool kanzi::AbstractRangeIterator::advance ( )
inline

Advances the iterator.

If the iterator was valid before advance() was called, it always increments. The return value only depends on whether the iterator is readable post the increment.

Returns
True if iterator was both advanced and is still readable.
PropertyObjectSharedPtr kanzi::AbstractRangeIterator::getPropertyObject ( )
inline

Access to a property object at the iterator location.

If the iterator is not valid, results are undefined.

Returns
Property object at location or nullptr.
bool kanzi::AbstractRangeIterator::getPropertyValue ( AbstractPropertyType  propertyType,
Variant value 
)
inline

Access a property at the iterator location.

If the iterator is not valid, results are undefined.

Parameters
propertyTypeproperty type to access.
valueVariant to store the value to.
Returns
If a property value could be written to output value true, false otherwise.
bool kanzi::AbstractRangeIterator::getValue ( Variant value)
inline

Access a value from a location.

If the iterator is not valid, results are undefined.

Parameters
valueVariant to store the value to.
Returns
If value could be written true, false otherwise.
kanzi::AbstractRangeIterator::operator bool ( ) const
inline

Operator for checking if the iterator has been initialized.

move() from an AbstractRangeIterator makes it uninitialized.

Returns
If the iterator is valid, true, otherwise false.
bool kanzi::AbstractRangeIterator::operator== ( const AbstractRangeIterator rhs) const
inline

Equals operator.

Parameters
rhsRight-hand-side operand.
Returns
If iterators are equal, true, otherwise false.
bool kanzi::AbstractRangeIterator::operator!= ( const AbstractRangeIterator rhs) const
inline

Not equals operator.

Parameters
rhsRight-hand-side operand.
Returns
If iterators are equal, true, otherwise false.
AbstractRangeIterator& kanzi::AbstractRangeIterator::operator= ( const AbstractRangeIterator other)
inline

Copy operator.

Parameters
otherSource object.
AbstractRangeIterator& kanzi::AbstractRangeIterator::operator= ( AbstractRangeIterator &&  other)
inlinenoexcept

Move operator.

Parameters
otherSource object.

Member Data Documentation

AbstractRangeLocationPtr kanzi::AbstractRangeIterator::m_location
protected

Location in this iterator.

AbstractIndexedRange* kanzi::AbstractRangeIterator::m_indexedRange
protected

Reference to indexed range.

size_t kanzi::AbstractRangeIterator::m_size
protected

Size of the indexed range.

size_t kanzi::AbstractRangeIterator::m_index
protected

Index of the iteration.


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