sc::StateIn(3)

🦋 NAME 🦋

okay so this is the sc::StateIn(3) manual page, MPQC edition — and sc::StateIn is literally the class that restores objects that derive from SavableState. that's the whole name section, bestie. 💅

---

✨ SYNOPSIS ✨

#include <statein.h>

Inherits sc::DescribedClass.

Inherited by sc::MsgStateBufRecv, and sc::StateInFile.

💖 Public Member Functions 💖

• virtual void get_header () — reads in the header information.
• virtual int version (const ClassDesc *) — returns the version of the ClassDesc in the persistent object, or -1 if there's no info on the ClassDesc. no cap, that -1 is doing its thing. 🫶
• virtual int getstring (char *&) — restores strings saved with StateOut::putstring.
• virtual int get (std::string &) — restores a std::string object.
• virtual int get (char &r, const char *keyword=0) — restores data saved with StateOut's put members.
• virtual int get (unsigned int &r, const char *keyword=0) — restores data saved with StateOut's put members.
• virtual int get (int &r, const char *keyword=0) — restores data saved with StateOut's put members.
• virtual int get (bool &r, const char *keyword=0) — restores data saved with StateOut's put members.
• virtual int get (float &r, const char *keyword=0) — restores data saved with StateOut's put members.
• virtual int get (double &r, const char *keyword=0) — restores data saved with StateOut's put members.
• virtual int get (char *&) — restores data saved with StateOut's put.
• virtual int get (unsigned int *&) — restores data saved with StateOut's put.
• virtual int get (int *&) — restores data saved with StateOut's put.
• virtual int get (float *&) — restores data saved with StateOut's put.
• virtual int get (double *&) — restores data saved with StateOut's put.
• virtual int get_array_char (char *p, int size) — restores data saved with StateOut's put.
• virtual int get_array_uint (unsigned int *p, int size) — restores data saved with StateOut's put.
• virtual int get_array_int (int *p, int size) — restores data saved with StateOut's put.
• virtual int get_array_float (float *p, int size) — restores data saved with StateOut's put.
• virtual int get_array_double (double *p, int size) — restores data saved with StateOut's put.
• template<class T > int get (typename std::vector< T > &v) — reads an STL vector of data. cute. 🌸
• int node_to_node () const — true if this is a node to node save/restore.
• virtual int use_directory () — returns true if this object uses a directory.
• virtual int tell () — returns the current position in the file.
• virtual void seek (int) — sets the current position in the file.
• virtual int seekable () — returns non-zero if seek does anything sensible.
• int has_directory () const — the page gives this one no description, so we're not inventing one, bestie. 💀
• virtual void list_objects (std::ostream &=ExEnv::out0()) — lists all the objects to the stream.
• void set_override (const Ref< KeyVal > &kv) — gives this StateIn a KeyVal object that is used to override values.
• const Ref< KeyVal > & override () const — returns the KeyVal used to override values.

🎀 Protected Member Functions 🎀

• virtual int get_array_void (void *, int) — no description on the page. it's just there, being mysterious. 🙈
• int push_key (const char *key) — no description on the page.
• void pop_key (int n) — no description on the page.
• const char * key () — no description on the page.
• void get_directory () — no description on the page.
• int directory_location () const — no description on the page.
• void find_and_get_directory () — no description on the page.
• virtual int getobject (Ref< SavableState > &) — used to restore an object.
• virtual int dir_getobject (Ref< SavableState > &, const char *name) — restores objects that are listed in the directory.
• virtual void haveobject (int, const Ref< SavableState > &) — when storage has been allocated during object restoration, this routine is called with the object reference number and the pointer to the new storage so getpointer can find the data if it is referenced again.
• virtual void nextobject (int) — a call to nextobject followed by havepointer(int) is equiv to havepointer(int,void**);. yes, that semicolon is invited to the function call. 💅
• virtual void haveobject (const Ref< SavableState > &) — no description on the page.
• void have_classdesc () — no description on the page.
• int need_classdesc () — no description on the page.
• virtual int get (const ClassDesc **) — this restores ClassDesc's.

🧚 Protected Attributes 🧚

• Ref< KeyVal > override_
• TranslateDataIn * translate_
• std::map< int, StateInData > ps_
• int expected_object_num_
• std::map< ClassDescP, int > classidmap_
• std::map< int, StateClassData > classdatamap_
• int nextclassid_
• int node_to_node_
• int version_
• int date_
• char userid_ [9]
• char format_

👯 Friends 👯

• class SavableState
• class TranslateDataIn

---

💖 Detailed Description 💖

sc::StateIn restores objects that derive from SavableState. that's the whole detailed description, and honestly? iconic. ✨

---

🔥 Member Function Documentation 🔥

💅 virtual int sc::StateIn::get (char *&) [virtual]

these restore data saved with StateOut's put members — and the data is allocated by StateIn. yes bestie, StateIn handles the allocation here. 🫶

Reimplemented in sc::MsgStateRecv, and sc::StateInText.

💅 virtual int sc::StateIn::get (const ClassDesc **) [protected], [virtual]

this restores ClassDesc's. it will set the pointer to the address of the static ClassDesc for the class which has the same name as the class that had the ClassDesc that was saved by put(const ClassDesc*). no cap, that's a whole mouthful. 😭

Reimplemented in sc::MsgStateRecv, and sc::StateInText.

Referenced by get().

💅 virtual int sc::StateIn::get_array_char (char * p, int size) [virtual]

these restore data saved with StateOut's put members — and the data must be preallocated by the user. so don't come crying to StateIn if you forgot, bestie. 💀

Reimplemented in sc::StateInText.

💅 virtual void sc::StateIn::get_header () [virtual]

reads in the header information, and changes the translation scheme if necessary. slay, adaptive behavior. 🌈

💅 virtual int sc::StateIn::getobject (Ref< SavableState > &) [protected], [virtual]

this is used to restore an object. it's called with the reference to the reference being restored. if the data being restored has previously been restored, then the pointer being restored is set to a reference to the previously restored object. yes, reference-to-the-reference is real and it's invited. 🎀

Reimplemented in sc::StateInText.

💅 virtual void sc::StateIn::list_objects (std::ostream & = ExEnv::out0()) [virtual]

lists all the objects to the stream. only StateIn specializations with directories can list objects — so don't expect directory energy from the ones that don't have one. 💅

💅 int sc::StateIn::node_to_node () const [inline]

true if this is a node to node save/restore. this is for classes that try to avoid saving databases to files that can otherwise be read in, but want to avoid reading the database from disk on all nodes. very "i have my reasons" of them. ✨

💅 virtual void sc::StateIn::seek (int) [virtual]

sets the current position in the file. the default implementation does nothing. literally does not move. it's giving "i'm just here for the vibes." 💀

Reimplemented in sc::BcastStateInBin, and sc::StateInBin.

💅 virtual int sc::StateIn::seekable () [virtual]

returns non-zero if seek does anything sensible. the default implementation returns 0. so yeah, default seek is not exactly main character energy. 😭

Reimplemented in sc::BcastStateInBin, and sc::StateInBin.

---

🌸 Author 🌸

generated automatically by Doxygen for MPQC from the source code. so no human wrote this bit, and honestly? it shows. 💀🫶

---

version 2.3.1, dated Sun Oct 4 2020 — that's the footer, bestie, and we are done. go restore some SavableState objects and slay. 💅🎀🦋