QMCDESC(3)

👑 QmcDesc — the metric description container, bestie edition 💅

okay so this is QmcDesc(3), a page from the Library Functions Manual (section 3, C++ library functions, iykyk). It's a container for a metric description and honestly? she's serving structure. ✨

---

✨ C++ SYNOPSIS ✨

like, this is how you get her in the door:

#include <QmcDesc.h>

c++ ... -lpcp_qmc -lpcp

yes bestie, you link -lpcp_qmc and -lpcp. both. no skipping. 🫶

---

🌸 DESCRIPTION 🌸

A QmcDesc object is literally just a container for a metric descriptor — that's a pmDesc, see PMAPI(3) — plus units. that's it. that's the whole vibe. she holds the descriptor and the units and she holds them well. 💖

---

🎀 CONSTRUCTORS & DESTRUCTOR 🎀

• ~QmcDesc(); — Destructor. she says bye. 💀
• QmcDesc(pmID pmid); — Construct a container for the descriptor for pmid. The descriptor is obtained from the current PMAPI(3) context using pmLookupDesc(3). so like, she goes and fetches it for you, main character energy fr fr. 👑

---

✨ DESCRIPTION ✨ (yes there's a second one, the manpage said so, not me 🙈)

• int status() const; — A status less than zero means the descriptor could not be obtained, and the PMAPI(3) error is encoded in the result. so like… check her status before you start acting brand new. 😭
• pmID id() const; — Return the pmID for this descriptor. her name tag. 🎀
• pmDesc desc() const; — Return a copy of the actual metric descriptor. a copy, bestie, not the original. 💅
• const pmDesc *descPtr() const; — Return a pointer to the actual descriptor, and the whole point of this one is to avoid using a pointer to a temporary. so if you need the real thing and not a ghost of a temporary, this is the one. 🦋

---

🌈 UNITS 🌈

• const QString &units() const; — The complete unit string for this descriptor. the full sentence, no abbreviations, she's being thorough. 💜
• const QString &shortUnits() const; — The unit string using abbreviations. the text-message version. ⭐
• bool useScaleUnits() const; — Returns true if the units have been set by a call to QmcDesc::setScaleUnits. literally just a vibe check on whether the scaling units got set. 🔥
• const pmUnits &scaleUnits() const; — Return the scaling units for this descriptor.
• void setScaleUnits(const pmUnits &units); — Set the scaling units for this descriptor. go off, set them. ✨

---

💀 DIAGNOSTICS 💀

Error messages are generated using pmprintf(3) but — and this is important bestie — they are not flushed. It is the responsibility of the user to call pmflush(3) to output any messages. like, she wrote the message, she did NOT hit send. that's on you. 🫶

no cap: if you don't call pmflush(3), you don't see the messages. the message exists in the void. the void does not text back. 😭

Additional diagnostics may be activated by adding the option pmc to the global debugging specification, as described in pmSetDebug(3). turn the dial up, queen. 👑

---

🦋 SEE ALSO 🦋

PMAPI(3), QMC(3), pmflush(3), pmLookupDesc(3) and pmprintf(3).

---

and that's the whole page, bestie 💖 this one's a Performance Co-Pilot situation from SGI, and it signs off as QMCDESC(3) — go forth and look up your descriptors, you're gonna slay. 🌸✨