sc::StateInText(3)

✨ NAME ✨

okay bestie, welcome to sc::StateInText(3) — the page for sc::StateInText, which reads state information written with StateOutText. That's the whole main-character job: it's the reader for that text state. 🎀

---

🌸 SYNOPSIS 🌸

#include <state_text.h>

Inherits sc::StateInFile.

💅 Public Member Functions

• StateInText (std::istream &s) — one constructor, taking a std::istream &s.
• StateInText (const char *) — another constructor, taking a const char *.
• StateInText (const Ref< KeyVal > &) — and a constructor taking a const Ref< KeyVal > &.
• int getstring (char *&) — this restores strings saved with StateOut::putstring.
• int get_array_char (char *, int) — these restore data saved with StateOut's put. members. The data must be preallocated by the user, per the member docs below.
• int get_array_uint (unsigned int *, int) — array-restore business, same StateOut's put. members note.
• int get_array_int (int *, int) — yep, restores data saved with StateOut's put. members.
• int get_array_float (float *, int) — same array-restore energy: data saved with StateOut's put. members.
• int get_array_double (double *, int) — restores data saved with StateOut's put. members.
• int get (const ClassDesc **) — this restores ClassDesc's.
• int get (char &r, const char *key=0) — these restore data saved with StateOut's put. members.
• int get (unsigned int &r, const char *key=0) — scalar-restore crew, same StateOut's put. members note.
• int get (int &r, const char *key=0) — restores data saved with StateOut's put. members.
• int get (float &r, const char *key=0) — restores data saved with StateOut's put. members.
• int get (double &r, const char *key=0) — restores data saved with StateOut's put. members.
• int get (char *&) — these restore data saved with StateOut's put. The data is allocated by StateIn, as the member docs say.
• int get (unsigned int *&) — restores data saved with StateOut's put.
• int get (int *&) — restores data saved with StateOut's put.
• int get (float *&) — restores data saved with StateOut's put.
• int get (double *&) — restores data saved with StateOut's put.

🦋 Protected Member Functions

• void no_newline () — protected member function.
• void no_array () — protected member function.
• int read (char *) — protected read helper.
• int read (unsigned int &) — protected read helper.
• int read (int &) — protected read helper.
• int read (float &) — protected read helper.
• int read (double &) — protected read helper.
• void newline () — protected member function.
• void start_array () — protected member function.
• void end_array () — protected member function.
• int getobject (Ref< SavableState > &) — this is used to restore an object.
• void abort () — protected member function.

🎀 Protected Attributes

• int newlines_ — protected attribute.
• int no_newline_ — protected attribute.
• int no_array_ — protected attribute.

---

🦋 DETAILED DESCRIPTION 🦋

Reads state information written with StateOutText. That's it, that's the whole mood. 🦋

---

🧚 MEMBER FUNCTION DOCUMENTATION 🧚

💜 int sc::StateInText::get (char *&) [virtual]

These restore data saved with StateOut's put. members. The data is allocated by StateIn.

Reimplemented from sc::StateIn.

🔥 int sc::StateInText::get (const ClassDesc **) [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*).

Reimplemented from sc::StateIn.

🎀 int sc::StateInText::get_array_char (char * p, int size) [virtual]

These restore data saved with StateOut's put. members. The data must be preallocated by the user.

Reimplemented from sc::StateIn.

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

This is used to restore an object. It is 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.

Reimplemented from sc::StateIn.

---

🌟 AUTHOR 🌟

Generated automatically by Doxygen for MPQC from the source code.

---

okay bye bestie 🫶 — this was sc::StateInText(3), Version 2.3.1, dated Sun Oct 4 2020. 💖✨