ost::MapIndex(3)

📦 version 1.8.1, in ubuntu jammy

💅 ost::MapIndex — from the `ost` library (section 3)

okay bestie, listen up, because this one is actually so cute once you get it. 💖

MapIndex is the little bestie that lets you walk through a MapTable linearly, when normally the only way you could get stuff out of that table was by key. It's giving "back door but make it legal". 🚪✨

You can increment it, check it, and dereference it just like a pointer, thanks to some very well-behaved operators. Iconic behavior honestly. 👑

✨ SYNOPSIS ✨

#include <object.h>

🫶 Public Member Functions

MapIndex () — Creates an empty map index (pointing to nothing).
MapIndex (MapObject *theObject) — Creates a map index pointing to a specific map object.
MapIndex (const MapIndex &theIndex) — Creates a copy of a given map index.
void * operator* () const — Dereference operator: the pointed object it is returned as void * for easy re-cast.
MapIndex & operator= (MapObject *theObject) — Assignment operator to avoid implicit cast.
MapIndex & operator++ () — Prefix increment operator, to be used in loops and such.
MapIndex operator++ (int) — Postfix increment operator, to be used in loops and such.
bool operator== (const MapIndex &theIndex) const — Comparison operator, between two MapIndex's.
bool operator!= (const MapIndex &theIndex) const
bool operator== (const MapObject *theObject) const — Comparison operator, between the MapIndex and a MapObject, useful to avoid casts for sake of clearness.
bool operator!= (const MapObject *theObject) const

🌸 Detailed Description 🌸

The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key.

It can be increased, checked and dereferenced like a pointer, by means of suitable operators. no cap, it really does move like a pointer fr fr 🦋

Author

Sergio Repetto s.repetto@pentaengineering.it

Index object to access MapTable elements

🎀 Constructor & Destructor Documentation 🎀

`ost::MapIndex::MapIndex ()` [inline]

Creates an empty map index (pointing to nothing). it's giving "empty vessel, no thoughts, head empty" but like, on purpose 💀

`ost::MapIndex::MapIndex (MapObject * theObject)` [inline]

Creates a map index pointing to a specific map object.

Parameters

the indexed object

`ost::MapIndex::MapIndex (const MapIndex & theIndex)` [inline]

Creates a copy of a given map index.

Parameters

the source index object

🧚 Member Function Documentation 🧚

`bool ost::MapIndex::operator!= (const MapIndex & theIndex) const` [inline]

`bool ost::MapIndex::operator!= (const MapObject * theObject) const` [inline]

`void* ost::MapIndex::operator* () const` [inline]

Dereference operator: the pointed object it is returned as void * for easy re-cast.

Returns

pointer to indexed object.

`MapIndex& ost::MapIndex::operator++ ()`

Prefix increment operator, to be used in loops and such. your classic ++it moment, main character energy 🔥

Returns