scf2read(3)

💖 scf2read — bestie edition 💖

okay so. we're deep in scf2read(3) territory, and yes it's a manual page, but it's also kind of a bop. this is all about translating to and from the Read structure. no cap. 🦋

✨ NAME ✨

scf2read, read2scf, exp2read, read2exp — translate to and from the Read structure. that's the whole vibe. 💅

🌸 SYNOPSIS 🌸

#include <Read.h>

Read *scf2read(
     Scf *scf);

Scf *read2scf(
     Read *read);

Exp_info *read2exp(
     Read *read,
     char *EN);

Read *exp2read(
     Exp_info *e);

four little functions, four little glow-ups. look at them. iconic. 👑

🎀 DESCRIPTION 🎀

so these functions are the backstage crew — they're used internally by the io library to convert between the in-memory representations of all the supported file formats. the Read structure is the main character here, the central format, which is why the only conversions you get are to and from it. periodt. and those conversions are: to and from the SCF format, and to and from the Experiment File format. that's it, that's the menu. 🍓

scf2read() takes an Scf structure and turns it into a Read structure. the Read structure is allocated by the function — so yes bestie, it's yours, you gotta deal with it. the Scf structure is left unchanged, untouched, unbothered. ✨

read2scf() goes the other way: Read structure in, Scf structure out. again, the Scf structure is allocated by the function, and the Read structure is left unchanged. no notes. 💖

exp2read() takes an Exp_info structure and makes it a Read structure. important lil detail: you must specify the entryname to use in the EN line type of the Experiment File. like, you have to say it. the Read structure is allocated by the function, and the Exp_info structure is left unchanged. 🫶

read2exp() takes a Read structure and turns it into an Exp_info structure. the Exp_info structure is allocated by the function, and the Read structure is left unchanged. we love a function that doesn't mess with your stuff. 💜

⭐ RETURN VALUES ⭐

if everything goes well, scf2read() and exp2read hand you back a pointer to a freshly allocated Read structure. if not? they hand you back NULLRead. that's the sad path bestie, and it's real. 😭

if everything goes well, read2scf hands you back a pointer to an allocated Scf structure. otherwise, this function returns a null pointer. 💀

if everything goes well, read2exp hands you back a pointer to an allocated Exp_info structure. otherwise, this function returns a null pointer. 💀

reminder: allocated means you are responsible for it. not me. not the function. you. 💅

🌈 SEE ALSO 🌈

• read_reading(3)
• fread_reading(3)
• write_reading(3)
• fwrite_reading(3)
• scf(4)
• ExperimentFile(4)

iykyk, go read those next. they're the rest of the lore. 📚✨

okay that's the whole page!! this one's from the Staden Package, and yeah, it's scf2read(3) — the header says so, the footer says so, and now you say so. go forth and convert, bestie, you're gonna slay. 💖🎀🦋🌸💅