Kanzi  3.9.5
Kanzi Engine API
kanzi::ViewRange::ViewRangeLocation Class Reference

Location class for indexed view range. More...

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

Inheritance diagram for kanzi::ViewRange::ViewRangeLocation:
[legend]

Public Member Functions

ViewRangegetRange ()
 Accesses the range with correct type. More...
 
const ViewRangegetRange () 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 (ViewRange &range, AbstractRangeLocationPtr location, size_t remainingLength)
 Creates a new 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...
 
bool isValidOverride () const override
 AbstractRangeLocation::isValidOverride() implementation. More...
 
bool matchesOverride (const AbstractRangeLocation &other) const override
 AbstractRangeLocation::matchesOverride() implementation. More...
 
 ViewRangeLocation (ViewRange &range, AbstractRangeLocationPtr location, size_t remainingLength)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::AbstractRangeLocation
 AbstractRangeLocation (AbstractRange &range)
 Constructor. More...
 

Protected Attributes

AbstractRangeLocationPtr m_location
 Location to the original range. More...
 
size_t m_remainingLength
 Remaining length. 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

◆ ViewRangeLocation()

kanzi::ViewRange::ViewRangeLocation::ViewRangeLocation ( ViewRange range,
AbstractRangeLocationPtr  location,
size_t  remainingLength 
)
inlineexplicitprotected

Constructor.

Parameters
rangeInput range.
locationRange location.
remainingLengthRemaining length.

Member Function Documentation

◆ create()

static AbstractRangeLocationPtr kanzi::ViewRange::ViewRangeLocation::create ( ViewRange range,
AbstractRangeLocationPtr  location,
size_t  remainingLength 
)
inlinestatic

Creates a new view range location.

Parameters
rangeInput range.
locationRange location.
remainingLengthRemaining length.
Returns
Range location.

◆ getRange() [1/2]

ViewRange& kanzi::ViewRange::ViewRangeLocation::getRange ( )
inline

Accesses the range with correct type.

Returns
Casted range.

◆ getRange() [2/2]

const ViewRange& kanzi::ViewRange::ViewRangeLocation::getRange ( ) const
inline

Accesses the range with correct type.

Returns
Casted range.

◆ cloneOverride()

unique_ptr<AbstractRangeLocation> kanzi::ViewRange::ViewRangeLocation::cloneOverride ( )
overrideprotectedvirtual

◆ matchesOverride()

bool kanzi::ViewRange::ViewRangeLocation::matchesOverride ( const AbstractRangeLocation other) const
overrideprotectedvirtual

◆ isValidOverride()

bool kanzi::ViewRange::ViewRangeLocation::isValidOverride ( ) const
overrideprotectedvirtual

◆ advanceOverride()

bool kanzi::ViewRange::ViewRangeLocation::advanceOverride ( )
overrideprotectedvirtual

◆ getPropertyObjectOverride()

PropertyObjectSharedPtr kanzi::ViewRange::ViewRangeLocation::getPropertyObjectOverride ( )
overrideprotectedvirtual

◆ getPropertyValueOverride()

bool kanzi::ViewRange::ViewRangeLocation::getPropertyValueOverride ( AbstractPropertyType  propertyType,
Variant value 
)
overrideprotectedvirtual

◆ getValueOverride()

bool kanzi::ViewRange::ViewRangeLocation::getValueOverride ( Variant value)
overrideprotectedvirtual

Member Data Documentation

◆ m_location

AbstractRangeLocationPtr kanzi::ViewRange::ViewRangeLocation::m_location
protected

Location to the original range.

◆ m_remainingLength

size_t kanzi::ViewRange::ViewRangeLocation::m_remainingLength
protected

Remaining length.


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