Kanzi  3.9.4
Kanzi Engine API
kanzi::TypedValueRange< T >::TypedValueRangeLocation Class Reference

Location implementation for typed value range. More...

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

Inheritance diagram for kanzi::TypedValueRange< T >::TypedValueRangeLocation:
[legend]

Static Public Member Functions

static AbstractRangeLocationPtr create (TypedValueRange &range, iterator iter)
 Creates a new range location. More...
 

Protected Member Functions

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

Protected Attributes

iterator m_iter
 Offset into the range. 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

template<typename T>
class kanzi::TypedValueRange< T >::TypedValueRangeLocation

Location implementation for typed value range.

Constructor & Destructor Documentation

◆ TypedValueRangeLocation()

template<typename T>
kanzi::TypedValueRange< T >::TypedValueRangeLocation::TypedValueRangeLocation ( TypedValueRange range,
iterator  iter 
)
inlineexplicitprotected

Constructor.

Parameters
rangeParent range.
iterIterator into the range.

Member Function Documentation

◆ create()

template<typename T>
static AbstractRangeLocationPtr kanzi::TypedValueRange< T >::TypedValueRangeLocation::create ( TypedValueRange range,
iterator  iter 
)
inlinestatic

Creates a new range location.

Parameters
rangeParent range.
iterIterator into the range.

◆ getRange() [1/2]

template<typename T>
TypedValueRange& kanzi::TypedValueRange< T >::TypedValueRangeLocation::getRange ( )
inlineprotected

Accesses the range with correct type.

Returns
Casted range.

◆ getRange() [2/2]

template<typename T>
const TypedValueRange& kanzi::TypedValueRange< T >::TypedValueRangeLocation::getRange ( ) const
inlineprotected

Accesses the range with correct type.

Returns
Casted range.

◆ cloneOverride()

template<typename T>
AbstractRangeLocationPtr kanzi::TypedValueRange< T >::TypedValueRangeLocation::cloneOverride ( )
inlineoverrideprotectedvirtual

AbstractValueRangeLocation::cloneOverride() implementation.

Implements kanzi::AbstractRangeLocation.

◆ matchesOverride()

template<typename T>
bool kanzi::TypedValueRange< T >::TypedValueRangeLocation::matchesOverride ( const AbstractRangeLocation other) const
inlineoverrideprotectedvirtual

AbstractValueRangeLocation::matchesOverride() implementation.

Implements kanzi::AbstractRangeLocation.

◆ isValidOverride()

template<typename T>
bool kanzi::TypedValueRange< T >::TypedValueRangeLocation::isValidOverride ( ) const
inlineoverrideprotectedvirtual

AbstractValueRangeLocation::isValidOverride() implementation.

Implements kanzi::AbstractRangeLocation.

◆ advanceOverride()

template<typename T>
bool kanzi::TypedValueRange< T >::TypedValueRangeLocation::advanceOverride ( )
inlineoverrideprotectedvirtual

AbstractValueRangeLocation::matchesOverride() implementation.

Implements kanzi::AbstractRangeLocation.

◆ getPropertyObjectOverride()

template<typename T>
PropertyObjectSharedPtr kanzi::TypedValueRange< T >::TypedValueRangeLocation::getPropertyObjectOverride ( )
inlineoverrideprotectedvirtual

AbstractValueRangeLocation::matchesOverride() implementation.

Implements kanzi::AbstractRangeLocation.

◆ getPropertyValueOverride()

template<typename T>
bool kanzi::TypedValueRange< T >::TypedValueRangeLocation::getPropertyValueOverride ( AbstractPropertyType  propertyType,
Variant value 
)
inlineoverrideprotectedvirtual

AbstractValueRangeLocation::getPropertyValueOverride() implementation.

Implements kanzi::AbstractRangeLocation.

◆ getValueOverride()

template<typename T>
bool kanzi::TypedValueRange< T >::TypedValueRangeLocation::getValueOverride ( Variant value)
inlineoverrideprotectedvirtual

AbstractValueRangeLocation::getValueOverride() implementation.

Implements kanzi::AbstractRangeLocation.

Member Data Documentation

◆ m_iter

template<typename T>
iterator kanzi::TypedValueRange< T >::TypedValueRangeLocation::m_iter
protected

Offset into the range.


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