ost::BaseObject(3)

✨ ost::BaseObject ✨ — from the ost library, section 3 of the Library Functions Manual 🫶

okay bestie, sit down, hydrate, and let me tell you about the literal blueprint of persistence 💅

---

🌸 NAME 🌸

ost::BaseObject — it's giving… BaseObject. that's the whole name. iconic of it honestly 👑

---

🎀 SYNOPSIS 🎀

#include <persist.h>

💜 Public Member Functions 💜

• BaseObject () — the constructor that gets called when you're doing serialisation stuff. it's the one CreateNewInstance rings up so it has an instance to call Read() on. very "let me create you so I can fill you in" energy.
• virtual ~BaseObject () — default destructor. nothing dramatic, just a clean exit. she leaves the group chat politely 😌
• virtual const char * getPersistenceID () const — hands you back the ID of the persistent object, aka its type. like a little name tag at the party 🏷️
• virtual bool write (Engine &archive) const — writes out to a Persistence::Engine. ⚠️ NOT the same as the << operator, because it only writes the data, not the object type or any of that extra garnish. data only, no seasoning 🧂
• virtual bool read (Engine &archive) — reads in from a Persistence::Engine. ⚠️ NOT the same as the >> operator either, because it does zero typesafety, not even a little bit. it trusts you completely. no cap 😭

---

🦋 DETAILED DESCRIPTION 🦋

BaseObject. she's the base of it all, fr fr.

this object is the base for all persistent data that isn't natively serialised by the Persistence::Engine. the ones the engine can't handle on its own? they come to her. she's the mother of the misfits 💖

she registers herself with the Persistence::TypeManager using a global constructor function. and then — plot twist — a matching deregister call happens in a global destructor. why? so that DLL's can use the Persistence::Engine inside a main executable. teamwork, babe 🤝

important warning, bestie, listen up: persistable objects must never maintain bad pointers. if a pointer doesn't point to something valid, it must be NULL. this is non-negotiable. it's how the persistence engine knows whether it should allocate memory for an object or whether the memory was already pre-allocated. bad pointer = chaos = we don't do that here 💀

👑 Author 👑

• Daniel Silverstone

Base class for classes that will be persistent. that's her whole job description and she does it flawlessly ✨

---

🌈 Constructor & Destructor Documentation 🌈

🍓 ost::BaseObject::BaseObject ()

this constructor is used in serialisation processes. specifically, it's called inside CreateNewInstance in order to create an instance of the class that's about to have Read() called on it. so like… she's born, and immediately gets read to. relatable honestly 🙈

💜 virtual ost::BaseObject::~BaseObject () [virtual]

default destructor. that's it. that's the whole thing. short and sweet, a queen of brevity 🎀

---

⭐ Member Function Documentation ⭐

🌸 virtual const char* ost::BaseObject::getPersistenceID () const [virtual]

this returns the ID of the persistent object — which is its type. your object's government name, essentially 💅

💖 virtual bool ost::BaseObject::read (Engine & archive) [virtual]

this method is used to read from a Persistence::Engine. and NO, it is not equivalent to the >> operator, because it does no typesafety or anything. it does not check. it does not verify. it simply reads. wild behavior, but okay 👀

🧚 virtual bool ost::BaseObject::write (Engine & archive) const [virtual]

this method is used to write to the Persistence::Engine. and NO again — it is not equivalent to the << operator, because it writes only the data and not the object type etc. just the data. the bare necessities. minimalism slay 🌿

---

👑 Author 👑

Generated automatically by Doxygen for GNU CommonC++ from the source code.

---

and that's the whole page, bestie!! you understood all of it, I know you did 💅✨ this was ost::BaseObject(3), from GNU CommonC++, dated Sun Dec 27 2020 — mwah, go forth and persist responsibly 🫶🎀