TaskProfile Class Reference

a simple class to keep track of one task that may be called multiple times. More...

#include <Profiler.h>

Collaboration diagram for TaskProfile:

Public Member Functions
	TaskProfile ()
	Task Profile. More...
virtual	~TaskProfile ()
void	Begin (const char *fileName, int lineNum, const char *taskDescription)
	start the task timer. More...
void	End (const char *fileName, int lineNum, const char *taskDescription)
	end the task timer. More...
double	ComputeAverageRunTime ()

Public Attributes
ArrayOf< char >	mFileName
int	mLine
ArrayOf< char >	mDescription
int	mNumHits
clock_t	mCumTime
clock_t	mLastTime

Detailed Description

a simple class to keep track of one task that may be called multiple times.

Definition at line 69 of file Profiler.h.

Constructor & Destructor Documentation

TaskProfile()

TaskProfile::TaskProfile

(

)

Task Profile.

Definition at line 116 of file Profiler.cpp.

{
   mCumTime=0;
   mNumHits=0;
}

References mCumTime, and mNumHits.

~TaskProfile()

TaskProfile::~TaskProfile ( )

virtual

Definition at line 122 of file Profiler.cpp.

{
}

Member Function Documentation

Begin()

void TaskProfile::Begin	(	const char *	fileName,
		int	lineNum,
		const char *	taskDescription
	)

start the task timer.

Definition at line 127 of file Profiler.cpp.

{
   if(!mFileName)
   {
      mFileName.reinit( strlen(fileName) + 1 );
      strcpy(mFileName.get(), fileName);
      mDescription.reinit( strlen(taskDescription) + 1 );
      strcpy(mDescription.get(), taskDescription);
      mLine = lineNum;
   }
 
   mLastTime = clock();
 
}

References mDescription, mFileName, mLastTime, mLine, and ArrayOf< X >::reinit().

Referenced by Profiler::Begin().

Here is the call graph for this function:

Here is the caller graph for this function:

ComputeAverageRunTime()

double TaskProfile::ComputeAverageRunTime

(

)

Definition at line 149 of file Profiler.cpp.

{
   if(mNumHits)
      return (double) ((double)mCumTime/CLOCKS_PER_SEC)/mNumHits;
   else
      return 0.0;
}

References mCumTime, and mNumHits.

End()

void TaskProfile::End	(	const char *	fileName,
		int	lineNum,
		const char *	taskDescription
	)

end the task timer.

Definition at line 143 of file Profiler.cpp.

{
   mCumTime += clock() - mLastTime;
   mNumHits++;
}

References mCumTime, mLastTime, and mNumHits.

Referenced by Profiler::End().

Here is the caller graph for this function:

Member Data Documentation

mCumTime

clock_t TaskProfile::mCumTime

Definition at line 86 of file Profiler.h.

Referenced by ComputeAverageRunTime(), End(), and TaskProfile().

mDescription

ArrayOf<char> TaskProfile::mDescription

Definition at line 84 of file Profiler.h.

Referenced by Begin().

mFileName

ArrayOf<char> TaskProfile::mFileName

Definition at line 82 of file Profiler.h.

Referenced by Begin().

mLastTime

clock_t TaskProfile::mLastTime

Definition at line 87 of file Profiler.h.

Referenced by Begin(), and End().

mLine

int TaskProfile::mLine

Definition at line 83 of file Profiler.h.

Referenced by Begin().

mNumHits

int TaskProfile::mNumHits

Definition at line 85 of file Profiler.h.

Referenced by ComputeAverageRunTime(), End(), and TaskProfile().

---

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

• Profiler.h
• Profiler.cpp