Kanzi  3.9.7
Kanzi Engine API
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. More...
 
const IndexedViewRangegetRange () const
 Accesses the range with correct type. More...
 
- 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...
 

Static Public Member Functions

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

Protected Member Functions

bool advanceOverride () override
 AbstractRangeLocation::advanceOverride() implementation. More...
 
unique_ptr< AbstractRangeLocationcloneOverride () override
 AbstractRangeLocation::cloneOverride() implementation. More...
 
PropertyObjectSharedPtr getPropertyObjectOverride () override
 AbstractRangeLocation::getPropertyObjectOverride() implementation. More...
 
bool getPropertyValueOverride (AbstractPropertyType propertyType, Variant &value) override
 AbstractRangeLocation::getPropertyValueOverride() implementation. More...
 
bool getValueOverride (Variant &value) override
 AbstractRangeLocation::getValueOverride() implementation. More...
 
 IndexedViewRangeLocation (IndexedViewRange &range, size_t index)
 Constructor. More...
 
bool isValidOverride () const override
 AbstractRangeLocation::isValidOverride() implementation. 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

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

Detailed Description

Location class for indexed view range.

Constructor & Destructor Documentation

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

Constructor.

Parameters
rangeInput range.
indexIndex into the range.

Member Function Documentation

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.
IndexedViewRange& kanzi::IndexedViewRange::IndexedViewRangeLocation::getRange ( )
inline

Accesses the range with correct type.

Returns
Casted range.
const IndexedViewRange& kanzi::IndexedViewRange::IndexedViewRangeLocation::getRange ( ) const
inline

Accesses the range with correct type.

Returns
Casted range.
unique_ptr<AbstractRangeLocation> kanzi::IndexedViewRange::IndexedViewRangeLocation::cloneOverride ( )
overrideprotectedvirtual
bool kanzi::IndexedViewRange::IndexedViewRangeLocation::matchesOverride ( const AbstractRangeLocation other) const
overrideprotectedvirtual
bool kanzi::IndexedViewRange::IndexedViewRangeLocation::isValidOverride ( ) const
overrideprotectedvirtual
bool kanzi::IndexedViewRange::IndexedViewRangeLocation::advanceOverride ( )
overrideprotectedvirtual
PropertyObjectSharedPtr kanzi::IndexedViewRange::IndexedViewRangeLocation::getPropertyObjectOverride ( )
overrideprotectedvirtual
bool kanzi::IndexedViewRange::IndexedViewRangeLocation::getPropertyValueOverride ( AbstractPropertyType  propertyType,
Variant value 
)
overrideprotectedvirtual
bool kanzi::IndexedViewRange::IndexedViewRangeLocation::getValueOverride ( Variant value)
overrideprotectedvirtual

Member Data Documentation

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

Index of iteration.


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