Public Member Functions

FBProfilerHelper Class Reference

Search for all occurrences

Detailed Description

FBProfilerHelper.

Should be created in the plug-in file where the profiling is to occur. See the class description in FBProfileTaskCycle for more details.

Definition at line 326 of file fbprofiler.h.

#include <fbprofiler.h>

List of all members.

Public Member Functions

 FBProfilerHelper (int pTC_RegisterationIndex, FBEvaluateInfo *pEvaluateInfo, FBProfileTaskCycle *pParentTaskCycle=NULL)
 Constructor.
 ~FBProfilerHelper ()
 Destructor.
void Stop ()
 Stop sample. Can be done manually, before destruction of the object.
bool IsStarted ()
 Test to see if profiling is started. Useful to verify if profiling is in progress.

Constructor & Destructor Documentation

FBProfilerHelper ( int  pTC_RegisterationIndex,
FBEvaluateInfo pEvaluateInfo,
FBProfileTaskCycle pParentTaskCycle = NULL 
)

Constructor.

Profiling sample for task cycle will start here. This will create a profiling object to work with.

Parameters:
pTC_RegisterationIndexTask Cycle registration index. Use FBProfiling_TaskCycleIndex to get this index.
pEvaluateInfoEvaluation informantion for this profiling object. Required to correctly build task cycle hierarchy.
pParentTaskCycleOptional, specify parent task cycles.

Destructor.

Profiling sample for task cycle will stop in here if not stopped before destruction.


Member Function Documentation

void Stop ( )

Stop sample. Can be done manually, before destruction of the object.

bool IsStarted ( ) [inline]

Test to see if profiling is started. Useful to verify if profiling is in progress.

Definition at line 345 of file fbprofiler.h.

{ return mCurrentTaskCycle != NULL; }

The documentation for this class was generated from the following file:

FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper
FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper FBProfilerHelper