Kanzi  3.9.7
Kanzi Engine API
kanzi::ImmutableSplitStringRange Class Reference

ImmutableSplitStringRange is an analogue to the ImmutableIteratorRange for a SplitStringRange. More...

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

Inheritance diagram for kanzi::ImmutableSplitStringRange:
[legend]

Static Public Member Functions

static ImmutableSplitStringRangeSharedPtr create (SplitStringRangeSharedPtr sourceRange, SplitStringRange::SplitPosition splitPos)
 Creates a new immutable split string range. More...
 

Protected Member Functions

AbstractRangeSharedPtr evaluateOverride () override
 AbstractRange::evaluateOverride() implementation. More...
 
PropertyObjectSharedPtr getPropertyObjectByIndexOverride (size_t index) override
 AbstractRange::getPropertyObjectByIndexOverride() implementation. More...
 
bool getPropertyValueByIndexOverride (size_t index, AbstractPropertyType propertyType, Variant &value) override
 AbstractRange::getPropertyValueByIndexOverride() implementation. More...
 
size_t getSizeOverride () override
 AbstractRange::getSizeOverride() implementation. More...
 
bool getValueByIndexOverride (size_t index, Variant &value) override
 AbstractRange::getValueByIndexOverride() implementation. More...
 
 ImmutableSplitStringRange (SplitStringRangeSharedPtr sourceRange, SplitStringRange::SplitPosition splitPos)
 Constructor. More...
 
AbstractRangeLocationPtr locationBeginOverride () override
 AbstractRange::locationBeginOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::AbstractIndexedRange
bool adaptViewOverride (AbstractRange &potentialViewRange, size_t length) override
 AbstractRange::adaptViewOverride() implementation. More...
 
AbstractRangeSharedPtr createViewOverride (size_t length) override
 AbstractRange::createViewOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::AbstractRange
 AbstractRange ()=default
 Constructor. More...
 

Protected Attributes

SplitStringRangeSharedPtr m_sourceRange
 Pointer to source range. More...
 
SplitStringRange::SplitPosition m_splitPos
 Split position in source range. More...
 

Additional Inherited Members

- Public Member Functions inherited from kanzi::AbstractIndexedRange
PropertyObjectSharedPtr getPropertyObjectByIndex (size_t index)
 Gets a property object by index. More...
 
bool getPropertyValueByIndex (size_t index, AbstractPropertyType propertyType, Variant &value)
 Access a property in a property object at an index. More...
 
size_t getSize ()
 Gets the size of the indexed range. More...
 
bool getValueByIndex (size_t index, Variant &value)
 Reads a value by index and writes it to a variant. More...
 
- Public Member Functions inherited from kanzi::AbstractRange
bool adaptView (AbstractRange &potentialViewRange, size_t length)
 Attempts to reuse a view over this range. More...
 
AbstractRangeIterator beginIteration ()
 Gets an iterator to the beginning of this range. More...
 
AbstractRangeSharedPtr createView (size_t length)
 Creates a view over this range. More...
 
AbstractRangeSharedPtr evaluate ()
 Evaluate the abstract range. More...
 
AbstractRangeLocationPtr locationBegin ()
 Gets an iteratable location to beginning of the range. More...
 
virtual ~AbstractRange ()=default
 Destructor. More...
 

Detailed Description

ImmutableSplitStringRange is an analogue to the ImmutableIteratorRange for a SplitStringRange.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

kanzi::ImmutableSplitStringRange::ImmutableSplitStringRange ( SplitStringRangeSharedPtr  sourceRange,
SplitStringRange::SplitPosition  splitPos 
)
inlineexplicitprotected

Constructor.

Parameters
sourceRangeSource split string range.
splitPosSplit position into the source range.

Member Function Documentation

static ImmutableSplitStringRangeSharedPtr kanzi::ImmutableSplitStringRange::create ( SplitStringRangeSharedPtr  sourceRange,
SplitStringRange::SplitPosition  splitPos 
)
static

Creates a new immutable split string range.

Parameters
sourceRangeSource split string range.
splitPosSplit position into the source range.
Returns
Immutable split string range shared pointer.
AbstractRangeSharedPtr kanzi::ImmutableSplitStringRange::evaluateOverride ( )
overrideprotectedvirtual

AbstractRange::evaluateOverride() implementation.

Reimplemented from kanzi::AbstractRange.

AbstractRangeLocationPtr kanzi::ImmutableSplitStringRange::locationBeginOverride ( )
overrideprotectedvirtual
size_t kanzi::ImmutableSplitStringRange::getSizeOverride ( )
overrideprotectedvirtual

AbstractRange::getSizeOverride() implementation.

Implements kanzi::AbstractIndexedRange.

PropertyObjectSharedPtr kanzi::ImmutableSplitStringRange::getPropertyObjectByIndexOverride ( size_t  index)
overrideprotectedvirtual

AbstractRange::getPropertyObjectByIndexOverride() implementation.

Implements kanzi::AbstractIndexedRange.

bool kanzi::ImmutableSplitStringRange::getPropertyValueByIndexOverride ( size_t  index,
AbstractPropertyType  propertyType,
Variant value 
)
overrideprotectedvirtual

AbstractRange::getPropertyValueByIndexOverride() implementation.

Implements kanzi::AbstractIndexedRange.

bool kanzi::ImmutableSplitStringRange::getValueByIndexOverride ( size_t  index,
Variant value 
)
overrideprotectedvirtual

AbstractRange::getValueByIndexOverride() implementation.

Implements kanzi::AbstractIndexedRange.

Member Data Documentation

SplitStringRangeSharedPtr kanzi::ImmutableSplitStringRange::m_sourceRange
protected

Pointer to source range.

SplitStringRange::SplitPosition kanzi::ImmutableSplitStringRange::m_splitPos
protected

Split position in source range.


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