RangeAccessBindingConcept is a processor that provides an interface for accessing values in a range. More...

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

Inheritance diagram for kanzi::RangeAccessBindingConcept:

Public Member Functions
size_t	getLength ()
	Gets the length of the range. More...

Variant *	getWriteRegister (size_t index)
	Accesses a register for writing by index. More...

bool	readValue (Variant &value, size_t index)
	Reads a value from range by index. More...

Protected Member Functions
virtual size_t	getLengthOverride ()=0
	Implementation-specific get of range length. More...

virtual Variant *	getWriteRegisterOverride (size_t index)
	Implementation-specific access to a writable register. More...

virtual bool	readValueOverride (Variant &value, size_t index)=0
	Implementation-specific read of value. More...

Detailed Description

RangeAccessBindingConcept is a processor that provides an interface for accessing values in a range.

This class does not provide functionality. It is inherited by classes that implement the range access interface.

Since: Kanzi 3.9.0

Member Function Documentation

size_t kanzi::RangeAccessBindingConcept::getLength ( )

inline

Gets the length of the range.

Returns: Range length.

Variant* kanzi::RangeAccessBindingConcept::getWriteRegister ( size_t index )

inline

Accesses a register for writing by index.

Parameters

index Index to read.

Returns: Pointer to register or nullptr.

bool kanzi::RangeAccessBindingConcept::readValue	(	Variant &	value,
		size_t	index
	)

inline

Reads a value from range by index.

Parameters

value	Value to write to.
index	Value index to write.

Returns: If value was read successfully, true, otherwise false.

virtual size_t kanzi::RangeAccessBindingConcept::getLengthOverride ( )

protectedpure virtual

Implementation-specific get of range length.

Returns: Range length.

Implemented in kanzi::RangeBindingProcessor, and kanzi::RangeStorageBindingProcessor.

virtual Variant* kanzi::RangeAccessBindingConcept::getWriteRegisterOverride ( size_t index )

protectedvirtual

Implementation-specific access to a writable register.

Default implementation throws an error.

Parameters

index Index of register to access.

Returns: Pointer to the register for writing values.

Reimplemented in kanzi::RangeStorageBindingProcessor.

virtual bool kanzi::RangeAccessBindingConcept::readValueOverride	(	Variant &	value,
		size_t	index
	)

protectedpure virtual

Implementation-specific read of value.

Parameters

value	Value to write to.
index	Value index to write.

Returns: If value was read successfully, true, otherwise false.

Implemented in kanzi::RangeBindingProcessor, and kanzi::RangeStorageBindingProcessor.

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

kanzi/core.ui/binding/range_access_binding_concept.hpp


Kanzi Engine API

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation