SoProfilerTopEngine(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

💖 NAME 💖

okay so bestie, meet SoProfilerTopEngine 🎀 — and the whole vibe here is that this class is yet to be documented. That's literally it. That's the entire name section. Not me opening the docs and finding a vibe check with no vibes 😭💀

✨ SYNOPSIS ✨

first things first, you pull it in like this:

#include <Inventor/annex/Profiler/engines/SoProfilerTopEngine.h>

and it Inherits SoEngine. family tree goes crazy, iykyk 🫶

🌸 Public Types 🌸

enum Column { NAME, COUNT, TIME_SECS, TIME_SECS_MAX, TIME_SECS_AVG, TIME_MSECS, TIME_MSECS_MAX, TIME_MSECS_AVG, TIME_PERCENT, TIME_PERCENT_MAX, TIME_PERCENT_AVG }
enum SortOrder { TIME_DEC, TIME_MAX_DEC, TIME_AVG_DEC, COUNT_DEC_TIME_DEC, COUNT_DEC_TIME_MAX_DEC, COUNT_DEC_TIME_AVG_DEC, ALPHANUMERIC_INC }

🦋 Public Member Functions 🦋

virtual SoType getTypeId (void) const
virtual const SoFieldData * getFieldData (void) const
virtual const SoEngineOutputData * getOutputData (void) const

🌈 Public Member Functions inherited from SoEngine 🌈

void evaluateWrapper (void)
virtual int getOutputs (SoEngineOutputList &l) const
SoEngineOutput * getOutput (const SbName &outputname) const
SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const
SbBool isNotifying (void) const
virtual void notify (SoNotList *nl)
SoEngine * copy (void) const
virtual SoFieldContainer * copyThroughConnection (void) const
SbBool shouldCopy (void) const
virtual void writeInstance (SoOutput *out)

🌈 Public Member Functions inherited from SoFieldContainer 🌈

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoField * getField (const SbName &name) const
virtual SoField * getEventIn (const SbName &name) const
virtual SoField * getEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *input)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool getIsBuiltIn (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
void setUserData (void *userdata) const
void * getUserData (void) const

🌈 Public Member Functions inherited from SoBase 🌈

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const — Returns TRUE if the type of this object is either of the same type or inherited from type. slay, runtime checks ✅
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
virtual void startNotify (void)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

💅 Static Public Member Functions 💅

static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void)

💅 Static Public Member Functions inherited from SoEngine 💅

static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. ✨
static void initClasses (void)
static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
static SoEngine * getByName (const SbName &name)
static int getByName (const SbName &name, SoEngineList &el)

💅 Static Public Member Functions inherited from SoFieldContainer 💅

static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. ✨
static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
static void cleanupClass (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
static void copyDone (void)

💅 Static Public Member Functions inherited from SoBase 💅

static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. ✨
static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
static void addName (SoBase *const base, const char *const name)
static void removeName (SoBase *const base, const char *const name)
static void incrementCurrentWriteCounter (void)
static void decrementCurrentWriteCounter (void)
static SoBase * getNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool readRoute (SoInput *input)

🍓 Public Attributes 🍓

these are the actual fields you can poke at, bestie 👇

SoMFName statisticsNames
SoMFTime statisticsTimings
SoMFTime statisticsTimingsMax
SoMFUInt32 statisticsCounts
SoMFEnum columns
SoSFEnum sortOrder
SoSFInt32 maxLines
SoSFFloat decay
SoEngineOutput prettyText

🧚 Protected Member Functions 🧚

virtual void evaluate (void)

🧚 Protected Member Functions inherited from SoEngine 🧚

SoEngine (void)
virtual ~SoEngine (void)
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void inputChanged (SoField *which)
void writeOutputTypes (SoOutput *out)

🧚 Protected Member Functions inherited from SoFieldContainer 🧚

SoFieldContainer (void)
virtual ~SoFieldContainer ()

🧚 Protected Member Functions inherited from SoBase 🧚

SoBase (void)
virtual ~SoBase ()
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const
virtual SoNotRec createNotRec (void)

💜 Static Protected Member Functions 💜

static const SoFieldData ** getInputDataPtr (void)
static const SoEngineOutputData ** getOutputDataPtr (void)

💜 Static Protected Member Functions inherited from SoEngine 💜

static const SoFieldData ** getInputDataPtr (void)
static const SoEngineOutputData ** getOutputDataPtr (void)

💜 Static Protected Member Functions inherited from SoBase 💜

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

👑 Additional Inherited Members 👑

👑 Protected Types inherited from SoBase 👑

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

👑 Protected Attributes inherited from SoFieldContainer 👑

SbBool isBuiltIn

🦋 Detailed Description 🦋

The SoProfilerTopEngine class is yet to be documented.

FIXME: write doc.

not the FIXME in the source 😭 somebody please write the doc, this class is out here living its unlabeled era 🙈

🌸 Member Function Documentation 🌸

⭐ `SoType SoProfilerTopEngine::getClassTypeId (void ) [static]`

This static method returns the SoType object associated with objects of this class.

⭐ `SoType SoProfilerTopEngine::getTypeId (void ) const [virtual]`

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Implements SoBase.

⭐ `const SoFieldData ** SoProfilerTopEngine::getInputDataPtr (void ) [static], [protected]`

Returns the SoFieldData class which holds information about inputs in this engine.

⭐ `const SoEngineOutputData ** SoProfilerTopEngine::getOutputDataPtr (void ) [static], [protected]`

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

⭐ `const SoFieldData * SoProfilerTopEngine::getFieldData (void ) const [virtual]`

Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoFieldContainer.

⭐ `const SoEngineOutputData * SoProfilerTopEngine::getOutputData (void ) const [virtual]`

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Implements SoEngine.

⭐ `void * SoProfilerTopEngine::createInstance (void ) [static]`

Creates a new instance of the class type corresponding to the SoType object. new instance just dropped, periodt 💅

⭐ `void SoProfilerTopEngine::evaluate (void ) [protected], [virtual]`

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.