Iterator for blocksList, supports forward and backward iteration. More...

#include <blocksList.h>

Inheritance diagram for original::blocksList< TYPE, ALLOC >::Iterator:

Collaboration diagram for original::blocksList< TYPE, ALLOC >::Iterator:

Public Member Functions
	Iterator (const Iterator &other)
	Copy constructor for the Iterator.

Iterator &	operator= (const Iterator &other)
	Assignment operator for the Iterator.

Iterator *	clone () const override
	Clones the iterator.

bool	hasNext () const override
	Checks if there is a next element.

bool	hasPrev () const override
	Checks if there is a previous element.

void	next () const override
	Moves the iterator to the next element.

void	prev () const override
	Moves the iterator to the previous element.

void	operator+= (integer steps) const override
	Advances the iterator by the specified number of steps.

void	operator-= (integer steps) const override
	Moves the iterator backward by the specified number of steps.

integer	operator- (const iterator< TYPE > &other) const override
	Computes the distance between two iterators.

Iterator *	getPrev () const override
	Gets the previous iterator.

Iterator *	getNext () const override
	Gets the next iterator.

TYPE &	get () override
	Gets the element pointed to by the iterator.

TYPE	get () const override
	Gets the element pointed to by the iterator (const version).

void	set (const TYPE &data) override
	Sets the value of the element pointed to by the iterator.

bool	isValid () const override
	Checks if the iterator is valid.

bool	atPrev (const iterator< TYPE > *other) const override
	Checks if the iterator is at the previous element relative to another iterator.

bool	atNext (const iterator< TYPE > *other) const override
	Checks if the iterator is at the next element relative to another iterator.

std::string	className () const override
	Gets the class name of the iterator.

Public Member Functions inherited from original::baseIterator< TYPE >
	~baseIterator () override=default
	Virtual destructor for proper cleanup of derived objects.

Public Member Functions inherited from original::iterator< TYPE >
TYPE &	operator* ()
	Dereferences the iterator to get the element.

TYPE	operator* () const
	Dereferences the iterator to get a copy of the element.

void	operator++ () const
	Moves the iterator forward by one position.

void	operator++ (int postfix) const
	Moves the iterator forward by one position (postfix).

void	operator-- () const
	Moves the iterator backward by one position.

void	operator-- (int postfix) const
	Moves the iterator backward by one position (postfix).

integer	compareTo (const iterator &other) const override
	Compares two iterators to determine their relative positions.

	operator bool () const
	Checks if the iterator is valid (i.e., points to a valid element).

bool	atPrev (const iterator &other) const
	Checks if this iterator is positioned at the previous element.

bool	atNext (const iterator &other) const
	Checks if this iterator is positioned at the next element.

virtual TYPE	getElem () const
	Returns a copy of the element.

bool	equal (const iterator *other) const
	Checks if two iterators are equal.

bool	equal (const iterator &other) const
	Checks if two iterators are equal.

std::string	className () const override
	Returns the class name of the iterator.

std::string	toString (bool enter) const override
	Returns a string representation of the iterator.

	~iterator () override=default
	Virtual destructor for proper cleanup of derived objects.

Public Member Functions inherited from original::printable
	operator std::string () const
	Explicit conversion to std::string.

	operator const char * () const
	Explicit conversion to C-style string.

const char *	toCString (bool enter) const
	Direct C-string access with formatting control.

template<typename TYPE>
auto	formatString (const TYPE &t) -> std::string

template<typename TYPE>
auto	formatCString (const TYPE &t) -> const char *

template<typename TYPE>
auto	formatEnum (const TYPE &t) -> std::string

template<typename TYPE>
auto	formatString (TYPE *const &ptr) -> std::string

Public Member Functions inherited from original::cloneable
	~cloneable () override=default
	Virtual destructor for cloneable.

Public Member Functions inherited from original::baseCloneable< cloneable >
virtual	~baseCloneable ()=default
	Virtual destructor for baseCloneable.

Public Member Functions inherited from original::comparable< iterator< TYPE > >
bool	operator== (const iterator< TYPE > &other) const
	Checks if the current object is equal to another.

bool	operator!= (const iterator< TYPE > &other) const
	Checks if the current object is not equal to another.

bool	operator< (const iterator< TYPE > &other) const
	Checks if the current object is less than another.

bool	operator> (const iterator< TYPE > &other) const
	Checks if the current object is greater than another.

bool	operator<= (const iterator< TYPE > &other) const
	Checks if the current object is less than or equal to another.

bool	operator>= (const iterator< TYPE > &other) const
	Checks if the current object is greater than or equal to another.

virtual	~comparable ()=default
	Virtual destructor for proper cleanup of derived objects.

Public Attributes
friend	blocksList

Additional Inherited Members
Static Public Member Functions inherited from original::printable
template<typename TYPE>
static std::string	formatString (const TYPE &t)
	Universal value-to-string conversion.

template<typename TYPE>
static std::string	formatString (TYPE *const &ptr)
	Pointer-specific formatting.

template<typename TYPE>
static const char *	formatCString (const TYPE &t)
	C-string cache for temporary usage.

template<typename TYPE>
static std::string	formatEnum (const TYPE &t)
	Enum formatting utility.

template<>
auto	formatString (const char &t) -> std::string

template<>
auto	formatString (const bool &t) -> std::string

template<>
auto	formatString (const char *const &ptr) -> std::string

Protected Member Functions inherited from original::cloneable
	cloneable ()=default
	Default constructor for cloneable.

Protected Member Functions inherited from original::baseCloneable< cloneable >
	baseCloneable ()=default
	Default constructor for baseCloneable.

Detailed Description

template<typename TYPE, typename ALLOC = allocator<TYPE>>
class original::blocksList< TYPE, ALLOC >::Iterator

Iterator for blocksList, supports forward and backward iteration.

This iterator allows iterating through the blocksList with random access.

Constructor & Destructor Documentation

◆ Iterator()

template<typename TYPE, typename ALLOC>

original::blocksList< TYPE, ALLOC >::Iterator::Iterator ( const Iterator & other )

Copy constructor for the Iterator.

Parameters

other The iterator to copy.

Member Function Documentation

◆ atNext()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::atNext ( const iterator< TYPE > * other ) const

overridevirtual

Checks if the iterator is at the next element relative to another iterator.

Parameters

other The other iterator to compare.

Returns: True if the iterator is at the next element, false otherwise.

Implements original::iterator< TYPE >.

◆ atPrev()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::atPrev ( const iterator< TYPE > * other ) const

overridevirtual

Checks if the iterator is at the previous element relative to another iterator.

Parameters

other The other iterator to compare.

Returns: True if the iterator is at the previous element, false otherwise.

Implements original::iterator< TYPE >.

◆ className()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::className ( ) const

nodiscardoverridevirtual

Gets the class name of the iterator.

Returns: The class name as a string.

Reimplemented from original::printable.

◆ clone()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::clone ( ) const

overridevirtual

Clones the iterator.

Returns: A new iterator pointing to the same element.

Implements original::baseIterator< TYPE >.

◆ get() [1/2]

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::get ( ) const

overridevirtual

Gets the element pointed to by the iterator (const version).

Returns: A const reference to the element.

Implements original::iterator< TYPE >.

◆ get() [2/2]

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::get ( )

overridevirtual

Gets the element pointed to by the iterator.

Returns: A reference to the element.

Implements original::iterator< TYPE >.

◆ getNext()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::getNext ( ) const

overridevirtual

Gets the next iterator.

Returns: A new iterator pointing to the next element.

Reimplemented from original::iterator< TYPE >.

◆ getPrev()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::getPrev ( ) const

overridevirtual

Gets the previous iterator.

Returns: A new iterator pointing to the previous element.

Implements original::iterator< TYPE >.

◆ hasNext()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::hasNext ( ) const

nodiscardoverridevirtual

Checks if there is a next element.

Returns: True if there is a next element, false otherwise.

Implements original::iterator< TYPE >.

◆ hasPrev()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::hasPrev ( ) const

nodiscardoverridevirtual

Checks if there is a previous element.

Returns: True if there is a previous element, false otherwise.

Implements original::iterator< TYPE >.

◆ isValid()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::isValid ( ) const

nodiscardoverridevirtual

Checks if the iterator is valid.

Returns: True if the iterator is valid, false otherwise.

Implements original::iterator< TYPE >.

◆ next()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::next ( ) const

overridevirtual

Moves the iterator to the next element.

Implements original::iterator< TYPE >.

◆ operator+=()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::operator+= ( integer steps ) const

overridevirtual

Advances the iterator by the specified number of steps.

Parameters

steps The number of steps to advance.

Implements original::iterator< TYPE >.

◆ operator-()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::operator- ( const iterator< TYPE > & other ) const

overridevirtual

Computes the distance between two iterators.

Parameters

other The other iterator to compare.

Returns: The distance between the two iterators.

Implements original::iterator< TYPE >.

◆ operator-=()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::operator-= ( integer steps ) const

overridevirtual

Moves the iterator backward by the specified number of steps.

Parameters

steps The number of steps to move backward.

Implements original::iterator< TYPE >.

◆ operator=()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::operator= ( const Iterator & other )

Assignment operator for the Iterator.

Parameters

other The iterator to assign.

Returns: A reference to this iterator.

◆ prev()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::prev ( ) const

overridevirtual

Moves the iterator to the previous element.

Implements original::iterator< TYPE >.

◆ set()

template<typename TYPE, typename ALLOC>

auto original::blocksList< TYPE, ALLOC >::Iterator::set ( const TYPE & data )

overridevirtual

Sets the value of the element pointed to by the iterator.

Parameters

data	The value to set.

Implements original::iterator< TYPE >.

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

src/core/blocksList.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Iterator()

Member Function Documentation

◆ atNext()

◆ atPrev()

◆ className()

◆ clone()

◆ get() [1/2]

◆ get() [2/2]

◆ getNext()

◆ getPrev()

◆ hasNext()

◆ hasPrev()

◆ isValid()

◆ next()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator=()

◆ prev()

◆ set()