Kanzi  3.9.6
Kanzi Engine API
kanzi::IteratorRange::IteratorRangeLocation Class Reference

Location implementation for iterator range. More...

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

Inheritance diagram for kanzi::IteratorRange::IteratorRangeLocation:
[legend]

Static Public Member Functions

static AbstractRangeLocationPtr create (IteratorRange &range, bool valid)
 Creates a new range location. More...
 

Protected Member Functions

bool advanceOverride () override
 AbstractRangeLocation::advanceOverride() implementation. More...
 
AbstractRangeLocationPtr cloneOverride () override
 AbstractRangeLocation::cloneOverride() implementation. More...
 
PropertyObjectSharedPtr getPropertyObjectOverride () override
 AbstractRangeLocation::getPropertyObjectOverride() implementation. More...
 
bool getPropertyValueOverride (AbstractPropertyType propertyType, Variant &value) override
 AbstractRangeLocation::getPropertyValueOverride() implementation. More...
 
IteratorRangegetRange ()
 Accesses the range with correct type. More...
 
const IteratorRangegetRange () const
 Accesses the range with correct type. More...
 
bool getValueOverride (Variant &value) override
 AbstractRangeLocation::getValueOverride() implementation. More...
 
bool isValidOverride () const override
 AbstractRangeLocation::isValidOverride() implementation. More...
 
 IteratorRangeLocation (IteratorRange &range, bool valid)
 Constructor. More...
 
bool matchesOverride (const AbstractRangeLocation &other) const override
 AbstractRangeLocation::matchesOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::AbstractRangeLocation
 AbstractRangeLocation (AbstractRange &range)
 Constructor. More...
 

Protected Attributes

bool m_valid
 Has this been advanced, or is it still valid? More...
 
- Protected Attributes inherited from kanzi::AbstractRangeLocation
AbstractRangem_range
 Reference to source range. More...
 

Additional Inherited Members

- Public Member Functions inherited from kanzi::AbstractRangeLocation
bool advance ()
 Advances the location. More...
 
unique_ptr< AbstractRangeLocationclone ()
 Returns a clone of this range location. More...
 
PropertyObjectSharedPtr getPropertyObject ()
 Access to a property object at the location. More...
 
bool getPropertyValue (AbstractPropertyType propertyType, Variant &value)
 Access a property in a property object at a location. More...
 
AbstractRangegetRange ()
 Returns a reference to the range being iterated. More...
 
const AbstractRangegetRange () const
 Returns a const reference to the range being iterated. More...
 
bool getValue (Variant &value)
 Access a value from a location. More...
 
bool isValid () const
 Indicates whether the location is valid. More...
 
bool matches (const AbstractRangeLocation &other) const
 Indicates whether a range location matches another. More...
 
 operator bool () const
 Cast to bool operator. More...
 
bool operator!= (const AbstractRangeLocation &rhs) const
 Not equals operator. More...
 
bool operator== (const AbstractRangeLocation &rhs) const
 Equals operator. More...
 
virtual ~AbstractRangeLocation ()=default
 Destructor. More...
 

Detailed Description

Location implementation for iterator range.

Constructor & Destructor Documentation

◆ IteratorRangeLocation()

kanzi::IteratorRange::IteratorRangeLocation::IteratorRangeLocation ( IteratorRange range,
bool  valid 
)
inlineexplicitprotected

Constructor.

Parameters
rangeParent range.
validFalse if the iterator range already been advanced.

Member Function Documentation

◆ create()

static AbstractRangeLocationPtr kanzi::IteratorRange::IteratorRangeLocation::create ( IteratorRange range,
bool  valid 
)
inlinestatic

Creates a new range location.

Parameters
rangeParent range.
validFalse if the iterator range already been advanced.

◆ getRange() [1/2]

IteratorRange& kanzi::IteratorRange::IteratorRangeLocation::getRange ( )
inlineprotected

Accesses the range with correct type.

Returns
Casted range.

◆ getRange() [2/2]

const IteratorRange& kanzi::IteratorRange::IteratorRangeLocation::getRange ( ) const
inlineprotected

Accesses the range with correct type.

Returns
Casted range.

◆ cloneOverride()

AbstractRangeLocationPtr kanzi::IteratorRange::IteratorRangeLocation::cloneOverride ( )
overrideprotectedvirtual

◆ matchesOverride()

bool kanzi::IteratorRange::IteratorRangeLocation::matchesOverride ( const AbstractRangeLocation other) const
overrideprotectedvirtual

◆ isValidOverride()

bool kanzi::IteratorRange::IteratorRangeLocation::isValidOverride ( ) const
overrideprotectedvirtual

◆ advanceOverride()

bool kanzi::IteratorRange::IteratorRangeLocation::advanceOverride ( )
overrideprotectedvirtual

◆ getPropertyObjectOverride()

PropertyObjectSharedPtr kanzi::IteratorRange::IteratorRangeLocation::getPropertyObjectOverride ( )
overrideprotectedvirtual

◆ getPropertyValueOverride()

bool kanzi::IteratorRange::IteratorRangeLocation::getPropertyValueOverride ( AbstractPropertyType  propertyType,
Variant value 
)
overrideprotectedvirtual

◆ getValueOverride()

bool kanzi::IteratorRange::IteratorRangeLocation::getValueOverride ( Variant value)
overrideprotectedvirtual

Member Data Documentation

◆ m_valid

bool kanzi::IteratorRange::IteratorRangeLocation::m_valid
protected

Has this been advanced, or is it still valid?


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