OST_OBJMAP(3)

πŸ“¦ version 1.8.1, in ubuntu jammy

✨ NAME ✨

ost::objMap< T, K, S > β€” bestie, this is a library function situation (section 3 of the manual, GNU CommonC++ flavor πŸ’…). What does it do? It's used to create and manage a hash index of objects through a common type. Periodt.


πŸŽ€ SYNOPSIS πŸŽ€

#include <objmap.h>

🌸 Static Public Member Functions 🌸

  • static T * getObject (keystring key) β€” the one you call when you actually wanna find somebody in the index, no cap.

πŸ¦‹ Protected Member Functions πŸ¦‹

  • virtual unsigned keyIndex (K k)
  • unsigned getSize (void)
  • objMap (const K key)

πŸ’œ Protected Attributes πŸ’œ

  • T * objNext
  • const K objKey

⭐ Static Protected Attributes ⭐

  • static T * objIndex [S]

🌈 DETAILED DESCRIPTION 🌈

template<class T, class K, unsigned S>
class ost::objMap< T, K, S >

Okay so it's literally this: a template that is used to create and manage a hash index of objects through a common type. The objects can be examined, and a specific instance can be located by a hash key. Iconic behavior, honestly.

Author: David Sugar dyfet@gnutelephony.org

hash indexed searchable template chain. 🫢

πŸ”₯ CONSTRUCTOR & DESTRUCTOR DOCUMENTATION πŸ”₯

template<class T , class K , unsigned S> ost::objMap< T, K, S >::objMap (const K key) [inline],  [protected]

There it is. The constructor. Inline, protected, doing its little thing. We love a protected constructor, it's giving exclusive πŸ’…


✨ MEMBER FUNCTION DOCUMENTATION ✨

template<class T , class K , unsigned S> T * ost::objMap< T, K, S >::getObject (keystring key) [static]
template<class T , class K , unsigned S> unsigned ost::objMap< T, K, S >::getSize (void) [inline],  [protected]
template<class T , class K , unsigned S> virtual unsigned ost::objMap< T, K, S >::keyIndex (K k) [inline],  [protected],  [virtual]

Referenced by ost::objMap< T, keystring, S >::objMap(). πŸ¦‹


πŸ’– MEMBER DATA DOCUMENTATION πŸ’–

template<class T , class K , unsigned S> T * ost::objMap< T, K, S >::objIndex () [static],  [protected]

Referenced by ost::objMap< T, keystring, S >::objMap().

template<class T , class K , unsigned S> const K ost::objMap< T, K, S >::objKey [protected]

Referenced by ost::objMap< T, keystring, S >::objMap().

template<class T , class K , unsigned S> T* ost::objMap< T, K, S >::objNext [protected]

Referenced by ost::objMap< T, keystring, S >::objMap().


πŸ‘‘ AUTHOR πŸ‘‘

Generated automatically by Doxygen for GNU CommonC++ from the source code. Not me writing this by hand, the robots did it, and honestly? Slay, robots. πŸ€–πŸ’…


That's the whole page, bestie! πŸ’– This one came out of the GNU CommonC++ library, generated on Sun Dec 27 2020, and it lives at ost::objMap< T, K, S >(3). Go forth and hash-index your objects, you absolute icon. πŸŒΈβœ¨πŸ¦‹

πŸ“¦ where this page comes from