sc::ClassDesc(3)

🌈 sc::ClassDesc(3) — the MPQC manual page, bestie 💖

🌸 NAME 🌸

sc::ClassDesc — bestie, this class is used to contain information about classes. That's literally the whole name blurb, ngl. 💅

✨ SYNOPSIS ✨

#include <class.h>

Inherits sc::Identity.

🎀 Public Member Functions 🎀

• ClassDesc (const std::type_info &, const char *, int=1, const char *p=0, DescribedClass *(*ctor)()=0, DescribedClass *(*keyvalctor)(const Ref< KeyVal > &)=0, DescribedClass *(*stateinctor)(StateIn &)=0) — the constructor, exactly as the original lists it. The page gives no extra description here, just this iconic signature — periodt. 🫶
• const ParentClasses & parents () const — signature only in the original, bestie; no separate blurb was provided, fr fr. 💜
• const char * name () const — Returns the name of the class. 🎀
• int version () const — Returns the version number of the class. ⭐
• DescribedClass * create_described_class () const — This member has been replaced by create(). Not me mourning the old name. 💀
• virtual DescribedClass * create () const — Create an instance of DescribedClass with exact type equal to the class to which this class descriptor belongs. 🔥
• virtual DescribedClass * create (const Ref< KeyVal > &) const — Create an instance of DescribedClass with exact type equal to the class to which this class descriptor belongs. 🦋
• virtual DescribedClass * create (StateIn &) const — Create an instance of DescribedClass with exact type equal to the class to which this class descriptor belongs. 🌸

🦋 Static Public Member Functions 🦋

• static std::map< std::string, ClassDescP > & all () — the original lists only this signature here, bestie. No extra one-liner given — iykyk. 🫶
• static void list_all_classes () — Writes a list of all of the classes to ExEnv::out0(). 🎀
• static ClassDesc * name_to_class_desc (const char *) — Given the name of the class, return a pointer to the class descriptor. ⭐
• static ClassDesc * class_desc (const std::type_info &) — Given a type_info object return a pointer to the ClassDesc. 🦋
• static int load_class (const char *classname) — Attempt to dynamically load the shared object file for classname. 🔥

🫶 Friends 🫶

• class ParentClasses — friend, that's the whole note. Short and iconic. 💜

💅 Detailed Description 💅

Okay so vibe check: this class is used to contain information about classes — yes, again, it's that important, bestie. 👑

Each DescribedClass type has a static ClassDesc member. This member has lists of the parents, children and virtual parents for each class. The ClassDesc class also has a static member that is a list of all described classes in the system. These lists are constructed as the constructors for the static ClassDesc members for each class are called and are completed before main is entered. See class for more information. 👑

💖 Member Function Documentation 💖

💜 virtual DescribedClass* sc::ClassDesc::create () const [virtual] 💜

Create an instance of DescribedClass with exact type equal to the class to which this class descriptor belongs. The constructor which takes no arguments is used. If this constructor doesn't exist or a static function that calls it with new wasn't given to this ClassDesc when it was created, then 0 will be returned. 😭

💜 virtual DescribedClass* sc::ClassDesc::create (const Ref< KeyVal > &) const [virtual] 💜

Create an instance of DescribedClass with exact type equal to the class to which this class descriptor belongs. The KeyVal& constructor is used. If this constructor doesn't exist or a static function that calls it with new wasn't passed to this ClassDesc, then 0 will be returned. 😭

💜 virtual DescribedClass* sc::ClassDesc::create (StateIn &) const [virtual] 💜

Create an instance of DescribedClass with exact type equal to the class to which this class descriptor belongs. The StateIn& constructor is used. If this constructor doesn't exist or a static function that calls it with new wasn't passed to this ClassDesc, then 0 will be returned. 😭

🌸 Author 🌸

This page was generated automatically by Doxygen for MPQC straight from the source code — it ate, no notes. 🫶

---

💌 and that's the sc::ClassDesc(3) page! from MPQC, version 2.3.1, dated Sun Oct 4 2020 — mwah, bye bestie! 🫶