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:

Public Member Functions
ViewRange &	getRange ()
	Accesses the range with correct type.
const ViewRange &	getRange () const
	Accesses the range with correct type.
Public Member Functions inherited from kanzi::AbstractRangeLocation
bool	advance ()
	Advances the location.
unique_ptr< AbstractRangeLocation >	clone ()
	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.
AbstractRange &	getRange ()
	Returns a reference to the range being iterated.
const AbstractRange &	getRange () 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 (ViewRange &range, AbstractRangeLocationPtr location, size_t remainingLength)
	Creates a new view range location.

Protected Member Functions
bool	advanceOverride () override
	AbstractRangeLocation::advanceOverride() implementation.
unique_ptr< AbstractRangeLocation >	cloneOverride () 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.
bool	isValidOverride () const override
	AbstractRangeLocation::isValidOverride() implementation.
bool	matchesOverride (const AbstractRangeLocation &other) const override
	AbstractRangeLocation::matchesOverride() implementation.
	ViewRangeLocation (ViewRange &range, AbstractRangeLocationPtr location, size_t remainingLength)
	Constructor.
Protected Member Functions inherited from kanzi::AbstractRangeLocation
	AbstractRangeLocation (AbstractRange &range)
	Constructor.

Protected Attributes
AbstractRangeLocationPtr	m_location
	Location to the original range.
size_t	m_remainingLength
	Remaining length.
Protected Attributes inherited from kanzi::AbstractRangeLocation
AbstractRange &	m_range
	Reference to source range.

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

range	Input range.
location	Range location.
remainingLength	Remaining 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

range	Input range.
location	Range location.
remainingLength	Remaining 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

AbstractRangeLocation::cloneOverride() implementation.

Implements kanzi::AbstractRangeLocation.

matchesOverride()

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

overrideprotectedvirtual

AbstractRangeLocation::matchesOverride() implementation.

Implements kanzi::AbstractRangeLocation.

isValidOverride()

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

overrideprotectedvirtual

AbstractRangeLocation::isValidOverride() implementation.

Implements kanzi::AbstractRangeLocation.

advanceOverride()

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

overrideprotectedvirtual

AbstractRangeLocation::advanceOverride() implementation.

Implements kanzi::AbstractRangeLocation.

getPropertyObjectOverride()

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

overrideprotectedvirtual

AbstractRangeLocation::getPropertyObjectOverride() implementation.

Implements kanzi::AbstractRangeLocation.

getPropertyValueOverride()

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

overrideprotectedvirtual

AbstractRangeLocation::getPropertyValueOverride() implementation.

Implements kanzi::AbstractRangeLocation.

getValueOverride()

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

overrideprotectedvirtual

AbstractRangeLocation::getValueOverride() implementation.

Implements kanzi::AbstractRangeLocation.

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:

• kanzi/core/property/view_range.hpp