FBProfilerHelper Class Reference

FBProfilerHelper. More...

#include <fbprofiler.h>

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.

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.

Constructor & Destructor Documentation

FBProfilerHelper()

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_RegisterationIndex	Task Cycle registration index. Use FBProfiling_TaskCycleIndex to get this index.
pEvaluateInfo	Evaluation informantion for this profiling object. Required to correctly build task cycle hierarchy.
pParentTaskCycle	Optional, specify parent task cycles.

~FBProfilerHelper()

~FBProfilerHelper

(

)

Destructor.

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

Member Function Documentation

IsStarted()

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.

Stop()

void Stop

(

)

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

---

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

• fbprofiler.h