sc::BcastStateInBin(3)

✨ sc::BcastStateInBin(3) ✨

okay so bestie, welcome to the MPQC manpage corner 💅 this one's all about sc::BcastStateInBin, and i promise it's less scary than the name looks 🫶

---

🌸 NAME 🌸

sc::BcastStateInBin — so like, BcastStateBin reads a file in written by StateInBin on node 0 and broadcasts it to all nodes so state can be simultaneously restored on all nodes. literally the group-chat forward of file data, no cap 💌

---

🦋 SYNOPSIS 🦋

#include <mstate.h>

Inherits sc::MsgStateBufRecv. the way it just inherits that, main character energy fr 👑

💖 Public Member Functions 💖

• BcastStateInBin(const Ref< KeyVal > &) — Create the BcastStateRecv using the default MessageGrp. yes bestie, default vibe ✨
• BcastStateInBin(const Ref< MessageGrp > &, const char *filename) — Create the BcastStateRecv. this one lets you pass the group and the filename yourself 🎀
• virtual int open(const char *name) — opens it up, iconic behaviour 💫
• virtual void close() — and closes it, we love a clean exit 🙈
• void seek(int loc) — Set the current position in the file. scoot to wherever loc is 🦋
• int seekable() — Return non-zero if seek does anything sensible. a little vibe check for your seek 🔍
• int tell() — Return the current position in the file. where are we rn bestie 📍
• int use_directory() — Returns true of this object uses a directory. (yes that's exactly what the original says, keep it 💀)

🧚 Protected Member Functions 🧚

• void next_buffer() — Specializations must implement next_buffer(). it's giving "you gotta do your part" 🫶
• int get_array_void(void *, int) — protected lil helper, living its best quiet life 🌈

💜 Protected Attributes 💜

• int opened_ — is it open or not, the eternal question 💭
• int file_position_ — where in the file we're at 📌
• std::streambuf * buf_ — the streambuf pointer, doing streambuf things ⭐

---

👑 Detailed Description 👑

BcastStateBin reads a file in written by StateInBin on node 0 and broadcasts it to all nodes so state can be simultaneously restored on all nodes. so node 0 reads it, everybody gets it, everybody restores together — synchronized slay 💅✨

---

🍓 Member Function Documentation 🍓

🌟 void sc::BcastStateInBin::seek(int) [virtual] 🌟

Set the current position in the file. The default implementation does nothing. like, literally nothing, it just sits there being default 😭

Reimplemented from sc::StateIn.

🌟 int sc::BcastStateInBin::seekable() [virtual] 🌟

Return non-zero if seek does anything sensible. The default implementation returns 0. so by default it's a no, ngl 🙅‍♀️

Reimplemented from sc::StateIn.

---

🎀 Author 🎀

Generated automatically by Doxygen for MPQC from the source code. not me being auto-generated 😭💀

---

okay bestie that's the whole page, you ate that 🫶 one last cute sign-off: this is Version 2.3.1, dated Sun Oct 4 2020 🌸💖✨