NCBI C++ ToolKit
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
CMacroStat Class Reference

Search Toolkit Book for CMacroStat

CMacroStat - collecting statistics about a single macro. More...

#include <gui/objutils/macro_engine.hpp>

+ Inheritance diagram for CMacroStat:
+ Collaboration diagram for CMacroStat:

Classes

class  CMacroLog
 

Public Member Functions

 CMacroStat ()
 
void Reset ()
 reset the macro name, qualifier and iteration counts More...
 
const CMacroLogGetMacroReport () const
 
void AddToReport (const string &report)
 function gradually builds the log report More...
 
void AddToErrorReport (const string &error)
 store encountered errors More...
 
void GatherUnMatchedTableEntries (const string &report, const int count)
 Used when applying a table to the entry: it stores the values and number of table entries that were not matched during execution. More...
 
const vector< pair< string, int > > & GetUnmatchedTableEntries () const
 
void AddDataChanged (bool change)
 function to collect whether any data was changed during the execution of the macro More...
 
void AddFunctionName (const string &func_name)
 function to collect DO function names to be used for processing reporting in huge file mode More...
 
const set< string > & GetDOFunctionNames () const
 
void LogStart (const string &macro_name)
 log start of macro execution More...
 
void LogStop (bool status, const string &err_message)
 log end of macro execution this includes time of execution, status, count of changed qualifiers and an error message when applicable result also goes to the GBench status bar More...
 
long GetExecutionTime () const
 
size_t GetCounter () const
 
bool HasDataUpdated () const
 
void AddFunctionLog (const CRef< IFunctionLog > &log)
 
const vector< CRef< IFunctionLog > > & GetFunctionsLog () const
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Private Member Functions

 CMacroStat (const CMacroStat &)
 
CMacroStatoperator= (const CMacroStat &)
 

Private Attributes

time_t m_StartTime
 
time_t m_StopTime
 
CMacroLog m_MacroReport
 
size_t m_counter { 0 }
 
vector< CRef< IFunctionLog > > m_FunctionsLog
 
bool m_DataUpdated { false }
 
set< stringm_FuncNames
 
vector< pair< string, int > > m_UnmatchedList
 

Additional Inherited Members

- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

CMacroStat - collecting statistics about a single macro.

collector for macro execution statistics, such as execution time and number of changed qualifiers everything is logged via LOG_POST so all standard logging conventions apply

Definition at line 58 of file macro_engine.hpp.


The documentation for this class was generated from the following files:
Modified on Thu Apr 11 15:08:00 2024 by modify_doxy.py rev. 669887