TypedValueRange is a template class for holding one type of object in a range. More...

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

Inheritance diagram for kanzi::TypedValueRange< T >:

Classes
class	TypedValueRangeLocation
	Location implementation for typed value range. More...

Public Types
using	const_iterator
	Const iterator type for values.

using	iterator
	Iterator type for values.

Public Member Functions
iterator	begin ()
	Gets an iterator to the beginning of the range.

const_iterator	begin () const
	Gets an iterator to the beginning of the range.

const_iterator	cbegin () const
	Gets an iterator to the beginning of the range.

const_iterator	cend () const
	Gets an iterator to the end of the range.

void	clear ()
	Clears all values from internal storage.

iterator	end ()
	Gets an iterator to the end of the range.

const_iterator	end () const
	Gets an iterator to the end of the range.

vector< T >::reference	operator[] (size_t index)
	Access operator.

vector< T >::const_reference	operator[] (size_t index) const
	Const access operator.

void	push_back (const T &value)
	Appends a value to the end of internal storage.

void	push_back (T &&value)
	Appends a value to the end of internal storage.

void	setValue (size_t index, const T &value)
	Sets a value to the internal storage index.

size_t	size () const
	Tells the number of elements in the range.

Public Member Functions inherited from kanzi::AbstractIndexedRange
PropertyObjectSharedPtr	getPropertyObjectByIndex (size_t index)
	Gets a property object by index.

bool	getPropertyValueByIndex (size_t index, AbstractPropertyType propertyType, Variant &value)
	Access a property in a property object at an index.

size_t	getSize ()
	Gets the size of the indexed range.

bool	getValueByIndex (size_t index, Variant &value)
	Reads a value by index and writes it to a variant.

Public Member Functions inherited from kanzi::AbstractRange
bool	adaptView (AbstractRange &potentialViewRange, size_t length)
	Attempts to reuse a view over this range.

AbstractRangeIterator	beginIteration ()
	Gets an iterator to the beginning of this range.

AbstractRangeSharedPtr	createView (size_t length)
	Creates a view over this range.

AbstractRangeSharedPtr	evaluate ()
	Evaluate the abstract range.

AbstractRangeLocationPtr	locationBegin ()
	Gets an iteratable location to beginning of the range.

virtual	~AbstractRange ()=default
	Destructor.

Static Public Member Functions
static shared_ptr< TypedValueRange >	create ()
	Creates a new typed value range.

Protected Member Functions
PropertyObjectSharedPtr	getPropertyObjectByIndexOverride (size_t index) override
	AbstractIndexedRange::getPropertyObjectByIndexOverride() implementation.

bool	getPropertyValueByIndexOverride (size_t index, AbstractPropertyType propertyType, Variant &value) override
	AbstractIndexedRange::getPropertyValueByIndexOverride() implementation.

size_t	getSizeOverride () override
	AbstractIndexedRange::getSizeOverride() implementation.

bool	getValueByIndexOverride (size_t index, Variant &value) override
	AbstractIndexedRange::getValueByIndexOverride() implementation.

AbstractRangeLocationPtr	locationBeginOverride () override
	AbstractRange::locationBeginOverride() implementation.

	TypedValueRange ()=default
	Default constructor.

Protected Member Functions inherited from kanzi::AbstractIndexedRange
bool	adaptViewOverride (AbstractRange &potentialViewRange, size_t length) override
	AbstractRange::adaptViewOverride() implementation.

AbstractRangeSharedPtr	createViewOverride (size_t length) override
	AbstractRange::createViewOverride() implementation.

Protected Member Functions inherited from kanzi::AbstractRange
	AbstractRange ()=default
	Constructor.

virtual AbstractRangeSharedPtr	evaluateOverride ()
	Implementation-dependent evaluation of the range.

Protected Attributes
vector< T >	m_values
	Container for single type of value.

Detailed Description

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

TypedValueRange is a template class for holding one type of object in a range.

TypedValueRange is intended to be inherited by inherited by internal range implementations of range-producing classes.

The ability to access the TypedValueRange values directly is intended for the creator of the range to manipulate it. Regular access to the values should happen through the virtual interface.

Since: Kanzi 3.9.0

Member Typedef Documentation

◆ iterator

template<typename T >

using kanzi::TypedValueRange< T >::iterator

Iterator type for values.

◆ const_iterator

template<typename T >

using kanzi::TypedValueRange< T >::const_iterator

Const iterator type for values.

Constructor & Destructor Documentation

◆ TypedValueRange()

template<typename T >

kanzi::TypedValueRange< T >::TypedValueRange ( )

explicitprotecteddefault

Default constructor.

Member Function Documentation

◆ create()

template<typename T >

static shared_ptr< TypedValueRange > kanzi::TypedValueRange< T >::create ( )

inlinestatic

Creates a new typed value range.

Returns: New typed value range.

◆ push_back() [1/2]

template<typename T >

void kanzi::TypedValueRange< T >::push_back ( const T & value )

inline

Appends a value to the end of internal storage.

Parameters

value Value to add.

◆ push_back() [2/2]

template<typename T >

void kanzi::TypedValueRange< T >::push_back ( T && value )

inline

Appends a value to the end of internal storage.

Parameters

value Value to add.

◆ setValue()

template<typename T >

void kanzi::TypedValueRange< T >::setValue	(	size_t	index,
		const T &	value )

inline

Sets a value to the internal storage index.

Parameters

index	Index to set.
value	Value to set.

◆ clear()

template<typename T >

void kanzi::TypedValueRange< T >::clear ( )

inline

Clears all values from internal storage.

◆ begin() [1/2]

template<typename T >

iterator kanzi::TypedValueRange< T >::begin ( )

inline

Gets an iterator to the beginning of the range.

Returns: Mutable iterator to the beginning of values.

◆ begin() [2/2]

template<typename T >

const_iterator kanzi::TypedValueRange< T >::begin ( ) const

inline

Gets an iterator to the beginning of the range.

Returns: Const iterator to the beginning of values.

◆ cbegin()

template<typename T >

const_iterator kanzi::TypedValueRange< T >::cbegin ( ) const

inline

Gets an iterator to the beginning of the range.

Returns: Const iterator to the beginning of values.

◆ end() [1/2]

template<typename T >

iterator kanzi::TypedValueRange< T >::end ( )

inline

Gets an iterator to the end of the range.

Returns: Mutable iterator to the end of values.

◆ end() [2/2]

template<typename T >

const_iterator kanzi::TypedValueRange< T >::end ( ) const

inline

Gets an iterator to the end of the range.

Returns: Const iterator to the end of values.

◆ cend()

template<typename T >

const_iterator kanzi::TypedValueRange< T >::cend ( ) const

inline

Gets an iterator to the end of the range.

Returns: Const iterator to the end of values.

◆ size()

template<typename T >

size_t kanzi::TypedValueRange< T >::size ( ) const

inline

Tells the number of elements in the range.

Returns: Element count.

◆ operator[]() [1/2]

template<typename T >

vector< T >::reference kanzi::TypedValueRange< T >::operator[] ( size_t index )

inline

Access operator.

Parameters

index Index to access.

Returns: Reference to value at index.

◆ operator[]() [2/2]

template<typename T >

vector< T >::const_reference kanzi::TypedValueRange< T >::operator[] ( size_t index ) const

inline

Const access operator.

Parameters

index Index to access.

Returns: Const reference to value at index.