FARGOS/VISTA Object Management Environment Core  ..
FARGOS/VISTA Object Management Environment Core Table of Contents
OMEprofileRecord Class Referenceabstract

Base class for OME profiling variable. More...

#include <OMEdebugInfo.h>

+ Inheritance diagram for OMEprofileRecord:

Public Member Functions

 OMEprofileRecord ()
 
virtual ~OMEprofileRecord ()
 
virtual const char * getName (uint_fast32_t *retNameLen=nullptr) const =0
 
virtual const OMEtype getValue () const =0
 
virtual void setValue (const OMEtype &newV)=0
 

Static Public Member Functions

static OMEarraylistDefinedCounters ()
 Get a list of all available information variables. More...
 
static OMEassocgetCounters ()
 Get a snapshot of all counters. More...
 
static const OMEtype getValueOfCounter (const char *name) NONNULL_PARAMETERS(1)
 Return the value of an named variable. More...
 
template<typename STREAMTYPE >
static STREAMTYPE & outputCounters (STREAMTYPE &o)
 Write a counter's value to an output stream. More...
 

Static Protected Member Functions

static void addToList (OMEprofileRecord *rec)
 
static void removeFromList (OMEprofileRecord *recToRemove)
 

Protected Attributes

OMEprofileRecordnext
 

Static Protected Attributes

static OMEprofileRecordstartOfList
 

Detailed Description

Base class for OME profiling variable.

Constructor & Destructor Documentation

◆ OMEprofileRecord()

OMEprofileRecord::OMEprofileRecord ( )
inline

◆ ~OMEprofileRecord()

virtual OMEprofileRecord::~OMEprofileRecord ( )
inlinevirtual

Member Function Documentation

◆ addToList()

static void OMEprofileRecord::addToList ( OMEprofileRecord rec)
inlinestaticprotected

◆ getCounters()

OMEassoc * OMEprofileRecord::getCounters ( )
static

Get a snapshot of all counters.

Returns
An OMEassoc subscripted by variable name.
Note
Potentially computationally-intensive.

References next, and startOfList.

Referenced by getSystemInfo().

◆ getName()

virtual const char* OMEprofileRecord::getName ( uint_fast32_t *  retNameLen = nullptr) const
pure virtual

◆ getValue()

virtual const OMEtype OMEprofileRecord::getValue ( ) const
pure virtual

◆ getValueOfCounter()

const OMEtype OMEprofileRecord::getValueOfCounter ( const char *  name)
static

Return the value of an named variable.

Parameters
nameidentifies the requested variable.
Returns
A read-only reference is returned. If the requested variable does not exist, nil is returned.

References next, and startOfList.

Referenced by getSystemInfoAttribute().

◆ listDefinedCounters()

OMEarray * OMEprofileRecord::listDefinedCounters ( )
static

Get a list of all available information variables.

Returns
An OMEarray, starting at subscript 0, of variable names.

References next, and startOfList.

◆ outputCounters()

template<typename STREAMTYPE >
static STREAMTYPE& OMEprofileRecord::outputCounters ( STREAMTYPE &  o)
inlinestatic

Write a counter's value to an output stream.

References l, and next.

◆ removeFromList()

static void OMEprofileRecord::removeFromList ( OMEprofileRecord recToRemove)
inlinestaticprotected

References next.

◆ setValue()

virtual void OMEprofileRecord::setValue ( const OMEtype newV)
pure virtual

Member Data Documentation

◆ next

◆ startOfList

OMEprofileRecord * OMEprofileRecord::startOfList
staticprotected

The documentation for this class was generated from the following files:
Generated: Fri Jul 31 2020 18:19:16
Support Information