Location into a range. More...

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

Inheritance diagram for kanzi::AbstractRangeLocation:

Public Member Functions
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.

Protected Member Functions
	AbstractRangeLocation (AbstractRange &range)
	Constructor.

virtual bool	advanceOverride ()=0
	Implementation-dependent advance.

virtual unique_ptr< AbstractRangeLocation >	cloneOverride ()=0
	Implementation-dependent clone operation.

virtual PropertyObjectSharedPtr	getPropertyObjectOverride ()=0
	Implementation-dependent access to a property object.

virtual bool	getPropertyValueOverride (AbstractPropertyType propertyType, Variant &value)=0
	Implementation-dependent access to a property in a property object.

virtual bool	getValueOverride (Variant &value)=0
	Implementation-dependent access to a value.

virtual bool	isValidOverride () const =0
	Implementation-dependent validity check.

virtual bool	matchesOverride (const AbstractRangeLocation &other) const =0
	Implementation-dependent check on whether a range location matches another.

Protected Attributes
AbstractRange &	m_range
	Reference to source range.

Detailed Description

Location into a range.

Abstract class used to accessing the range. Created by the range and dereferenced from AbstractRangeIterator. Virtual access to AbstractRange is implemented through AbstractRangeLocation. If the source range becomes invalid, the location is by definition invalid.

Since: Kanzi 3.9.0

Constructor & Destructor Documentation

◆ ~AbstractRangeLocation()

virtual kanzi::AbstractRangeLocation::~AbstractRangeLocation ( )

virtualdefault

Destructor.

◆ AbstractRangeLocation()

kanzi::AbstractRangeLocation::AbstractRangeLocation ( AbstractRange & range )

inlineexplicitprotected

Constructor.

Parameters

range Source range.

Member Function Documentation

◆ getRange() [1/2]

AbstractRange & kanzi::AbstractRangeLocation::getRange ( )

inline

Returns a reference to the range being iterated.

This function should have a static polymorphism override in inheriting location classes.

Returns: Reference to a range.

◆ getRange() [2/2]

const AbstractRange & kanzi::AbstractRangeLocation::getRange ( ) const

inline

Returns a const reference to the range being iterated.

This function should have a static polymorphism override in inheriting location classes.

Returns: Const reference to a range.

◆ clone()

unique_ptr< AbstractRangeLocation > kanzi::AbstractRangeLocation::clone ( )

inline

Returns a clone of this range location.

Returns: Clone of this range location.

◆ matches()

bool kanzi::AbstractRangeLocation::matches ( const AbstractRangeLocation & other ) const

inline

Indicates whether a range location matches another.

Parameters

other Other range location.

Returns: If locations match, true, false otherwise.

◆ isValid()

bool kanzi::AbstractRangeLocation::isValid ( ) const

inline

Indicates whether the location is valid.

A location is valid if it's not at the end of iteration and can be read.

Returns: If the location is valid, true, false otherwise.

◆ advance()

bool kanzi::AbstractRangeLocation::advance ( )

inline

Advances the location.

If the location was valid before advance() was called, it always increments. The return value only depends on whether the location is readable post the increment.

Returns: True if location was both advanced and is still readable.

◆ getPropertyObject()

PropertyObjectSharedPtr kanzi::AbstractRangeLocation::getPropertyObject ( )

inline

Access to a property object at the location.

If the location is not valid, the implementation must not crash. Implementation may or may not return a default value for an invalid location.

Returns: Property object at location or nullptr.

◆ getPropertyValue()

bool kanzi::AbstractRangeLocation::getPropertyValue	(	AbstractPropertyType	propertyType,
		Variant &	value )

inline

Access a property in a property object at a location.

If the location is not valid, the implementation must not crash. Implementation may or may not return a default value for an invalid location.

Parameters

propertyType	property type to access.
value	Variant to store the value to.

Returns: If a value was true, false otherwise.

◆ getValue()

bool kanzi::AbstractRangeLocation::getValue ( Variant & value )

inline

Access a value from a location.

If the location is not valid, the implementation must not crash. Implementation may or may not return a default value for an invalid location.

Parameters

value Variant to store the value to.

Returns: If a value was true, false otherwise.

◆ operator bool()

kanzi::AbstractRangeLocation::operator bool ( ) const

inline

Cast to bool operator.

Returns: If the iterator is valid and can be dereferenced true, false otherwise.

◆ operator==()

bool kanzi::AbstractRangeLocation::operator== ( const AbstractRangeLocation & rhs ) const

inline

Equals operator.

Parameters

rhs	Right-hand-side operand.

Returns: If locations are equal, true, otherwise false.

◆ operator!=()

bool kanzi::AbstractRangeLocation::operator!= ( const AbstractRangeLocation & rhs ) const

inline

Not equals operator.

Parameters

rhs	Right-hand-side operand.

Returns: If locations are equal, true, otherwise false.

◆ cloneOverride()

virtual unique_ptr< AbstractRangeLocation > kanzi::AbstractRangeLocation::cloneOverride ( )

protectedpure virtual

Implementation-dependent clone operation.

Returns: Clone of this range location.

Implemented in kanzi::IteratorRange::IteratorRangeLocation, kanzi::PropertyAccessRange::PropertyAccessRangeLocation, kanzi::IndexedPropertyAccessRange::IndexedPropertyAccessRangeLocation, kanzi::SplitStringRange::SplitStringRangeLocation, kanzi::TypedValueRange< T >::TypedValueRangeLocation, kanzi::ValueRange::ValueRangeLocation, kanzi::ViewRange::ViewRangeLocation, and kanzi::IndexedViewRange::IndexedViewRangeLocation.

◆ matchesOverride()

virtual bool kanzi::AbstractRangeLocation::matchesOverride ( const AbstractRangeLocation & other ) const

protectedpure virtual

Implementation-dependent check on whether a range location matches another.

Parameters

other Other range location.

Returns: If locations match, true, false otherwise.

Implemented in kanzi::IteratorRange::IteratorRangeLocation, kanzi::PropertyAccessRange::PropertyAccessRangeLocation, kanzi::IndexedPropertyAccessRange::IndexedPropertyAccessRangeLocation, kanzi::SplitStringRange::SplitStringRangeLocation, kanzi::TypedValueRange< T >::TypedValueRangeLocation, kanzi::ValueRange::ValueRangeLocation, kanzi::ViewRange::ViewRangeLocation, and kanzi::IndexedViewRange::IndexedViewRangeLocation.

◆ isValidOverride()

virtual bool kanzi::AbstractRangeLocation::isValidOverride ( ) const

protectedpure virtual

Implementation-dependent validity check.

Returns: If the location is valid, true, false otherwise.

Implemented in kanzi::IteratorRange::IteratorRangeLocation, kanzi::PropertyAccessRange::PropertyAccessRangeLocation, kanzi::IndexedPropertyAccessRange::IndexedPropertyAccessRangeLocation, kanzi::SplitStringRange::SplitStringRangeLocation, kanzi::TypedValueRange< T >::TypedValueRangeLocation, kanzi::ValueRange::ValueRangeLocation, kanzi::ViewRange::ViewRangeLocation, and kanzi::IndexedViewRange::IndexedViewRangeLocation.

◆ advanceOverride()

virtual bool kanzi::AbstractRangeLocation::advanceOverride ( )

protectedpure virtual

Implementation-dependent advance.

Returns: True if location was both advanced and is still readable.

Implemented in kanzi::IteratorRange::IteratorRangeLocation, kanzi::PropertyAccessRange::PropertyAccessRangeLocation, kanzi::IndexedPropertyAccessRange::IndexedPropertyAccessRangeLocation, kanzi::SplitStringRange::SplitStringRangeLocation, kanzi::TypedValueRange< T >::TypedValueRangeLocation, kanzi::ValueRange::ValueRangeLocation, kanzi::ViewRange::ViewRangeLocation, and kanzi::IndexedViewRange::IndexedViewRangeLocation.

◆ getPropertyObjectOverride()

virtual PropertyObjectSharedPtr kanzi::AbstractRangeLocation::getPropertyObjectOverride ( )

protectedpure virtual

Implementation-dependent access to a property object.

Returns: Property object at location or nullptr.

Implemented in kanzi::IteratorRange::IteratorRangeLocation, kanzi::PropertyAccessRange::PropertyAccessRangeLocation, kanzi::IndexedPropertyAccessRange::IndexedPropertyAccessRangeLocation, kanzi::SplitStringRange::SplitStringRangeLocation, kanzi::TypedValueRange< T >::TypedValueRangeLocation, kanzi::ValueRange::ValueRangeLocation, kanzi::ViewRange::ViewRangeLocation, and kanzi::IndexedViewRange::IndexedViewRangeLocation.

◆ getPropertyValueOverride()

virtual bool kanzi::AbstractRangeLocation::getPropertyValueOverride	(	AbstractPropertyType	propertyType,
		Variant &	value )

protectedpure virtual

Implementation-dependent access to a property in a property object.

Parameters

propertyType	property type to access.
value	Variant to store the value to.

Returns: If a value was true, false otherwise.

Implemented in kanzi::IteratorRange::IteratorRangeLocation, kanzi::PropertyAccessRange::PropertyAccessRangeLocation, kanzi::IndexedPropertyAccessRange::IndexedPropertyAccessRangeLocation, kanzi::SplitStringRange::SplitStringRangeLocation, kanzi::TypedValueRange< T >::TypedValueRangeLocation, kanzi::ValueRange::ValueRangeLocation, kanzi::ViewRange::ViewRangeLocation, and kanzi::IndexedViewRange::IndexedViewRangeLocation.

◆ getValueOverride()

virtual bool kanzi::AbstractRangeLocation::getValueOverride ( Variant & value )

protectedpure virtual

Implementation-dependent access to a value.

Parameters

value Variant to store the value to.

Returns: If a value was true, false otherwise.

Implemented in kanzi::IteratorRange::IteratorRangeLocation, kanzi::PropertyAccessRange::PropertyAccessRangeLocation, kanzi::IndexedPropertyAccessRange::IndexedPropertyAccessRangeLocation, kanzi::SplitStringRange::SplitStringRangeLocation, kanzi::TypedValueRange< T >::TypedValueRangeLocation, kanzi::ValueRange::ValueRangeLocation, kanzi::ViewRange::ViewRangeLocation, and kanzi::IndexedViewRange::IndexedViewRangeLocation.

Member Data Documentation

◆ m_range

AbstractRange& kanzi::AbstractRangeLocation::m_range

protected

Reference to source range.

The reference is shared, since temporary ranges must remain valid if they're being iterated.

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

kanzi/core/property/abstract_range.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~AbstractRangeLocation()

◆ AbstractRangeLocation()

Member Function Documentation

◆ getRange() [1/2]

◆ getRange() [2/2]

◆ clone()

◆ matches()

◆ isValid()

◆ advance()

◆ getPropertyObject()

◆ getPropertyValue()

◆ getValue()

◆ operator bool()

◆ operator==()

◆ operator!=()

◆ cloneOverride()

◆ matchesOverride()

◆ isValidOverride()

◆ advanceOverride()

◆ getPropertyObjectOverride()

◆ getPropertyValueOverride()

◆ getValueOverride()

Member Data Documentation

◆ m_range