Kanzi 3.9.10
kanzi::IndexedViewRange::IndexedViewRangeLocation Class Reference

Location class for indexed view range. More...

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

Inheritance diagram for kanzi::IndexedViewRange::IndexedViewRangeLocation:
[legend]

Public Member Functions

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

Static Public Member Functions

static AbstractRangeLocationPtr create (IndexedViewRange &range, size_t index)
 Creates a new indexed view range location.
 

Protected Member Functions

bool advanceOverride () override
 AbstractRangeLocation::advanceOverride() implementation.
 
unique_ptr< AbstractRangeLocationcloneOverride () override
 AbstractRangeLocation::cloneOverride() implementation.
 
PropertyObjectSharedPtr getPropertyObjectOverride () override
 AbstractRangeLocation::getPropertyObjectOverride() implementation.
 
bool getPropertyValueOverride (AbstractPropertyType propertyType, Variant &value) override
 AbstractRangeLocation::getPropertyValueOverride() implementation.
 
bool getValueOverride (Variant &value) override
 AbstractRangeLocation::getValueOverride() implementation.
 
 IndexedViewRangeLocation (IndexedViewRange &range, size_t index)
 Constructor.
 
bool isValidOverride () const override
 AbstractRangeLocation::isValidOverride() implementation.
 
bool matchesOverride (const AbstractRangeLocation &other) const override
 AbstractRangeLocation::matchesOverride() implementation.
 
- Protected Member Functions inherited from kanzi::AbstractRangeLocation
 AbstractRangeLocation (AbstractRange &range)
 Constructor.
 

Protected Attributes

size_t m_index
 Index of iteration.
 
- Protected Attributes inherited from kanzi::AbstractRangeLocation
AbstractRangem_range
 Reference to source range.
 

Detailed Description

Location class for indexed view range.

Constructor & Destructor Documentation

◆ IndexedViewRangeLocation()

kanzi::IndexedViewRange::IndexedViewRangeLocation::IndexedViewRangeLocation ( IndexedViewRange & range,
size_t index )
inlineexplicitprotected

Constructor.

Parameters
rangeInput range.
indexIndex into the range.

Member Function Documentation

◆ create()

static AbstractRangeLocationPtr kanzi::IndexedViewRange::IndexedViewRangeLocation::create ( IndexedViewRange & range,
size_t index )
inlinestatic

Creates a new indexed view range location.

Parameters
rangeInput range.
indexIndex of iteration.
Returns
Range location.

◆ getRange() [1/2]

IndexedViewRange & kanzi::IndexedViewRange::IndexedViewRangeLocation::getRange ( )
inline

Accesses the range with correct type.

Returns
Casted range.

◆ getRange() [2/2]

const IndexedViewRange & kanzi::IndexedViewRange::IndexedViewRangeLocation::getRange ( ) const
inline

Accesses the range with correct type.

Returns
Casted range.

◆ cloneOverride()

unique_ptr< AbstractRangeLocation > kanzi::IndexedViewRange::IndexedViewRangeLocation::cloneOverride ( )
overrideprotectedvirtual

◆ matchesOverride()

bool kanzi::IndexedViewRange::IndexedViewRangeLocation::matchesOverride ( const AbstractRangeLocation & other) const
overrideprotectedvirtual

◆ isValidOverride()

bool kanzi::IndexedViewRange::IndexedViewRangeLocation::isValidOverride ( ) const
overrideprotectedvirtual

◆ advanceOverride()

bool kanzi::IndexedViewRange::IndexedViewRangeLocation::advanceOverride ( )
overrideprotectedvirtual

◆ getPropertyObjectOverride()

PropertyObjectSharedPtr kanzi::IndexedViewRange::IndexedViewRangeLocation::getPropertyObjectOverride ( )
overrideprotectedvirtual

◆ getPropertyValueOverride()

bool kanzi::IndexedViewRange::IndexedViewRangeLocation::getPropertyValueOverride ( AbstractPropertyType propertyType,
Variant & value )
overrideprotectedvirtual

◆ getValueOverride()

bool kanzi::IndexedViewRange::IndexedViewRangeLocation::getValueOverride ( Variant & value)
overrideprotectedvirtual

Member Data Documentation

◆ m_index

size_t kanzi::IndexedViewRange::IndexedViewRangeLocation::m_index
protected

Index of iteration.


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