A simple class which helps to time profiling to determine what fraction of time each component of a loop is taking. More...

#include <TimeProfiler.hpp>

Collaboration diagram for Sirikata::TimeProfiler:

List of all members.

Classes
struct	Stage
Public Member Functions
	TimeProfiler (const Context *ctx, const String &name)
	~TimeProfiler ()
Stage *	addStage (const String &name)
	Add a stage for profiling, not categorized under any group.
Stage *	addStage (const String &group_name, const String &name)
	Add a stage for profiling under the specified group.
void	report () const
Private Types
typedef std::vector< Stage * >	StageList
typedef std::map< String, StageList >	GroupMap
Private Member Functions
void	remove (Stage *stage)
Private Attributes
const Context *	mContext
String	mName
GroupMap	mGroups
StageList	mFreeStages
Friends
class	Stage

Detailed Description

A simple class which helps to time profiling to determine what fraction of time each component of a loop is taking.

It assumes each step is performed every time. Events with human-friendly names are added to the list and then the main loop simply indicates when each stage completes. When complete, call the report method to get a simple analysis.

Member Typedef Documentation

typedef std::map<String, StageList> Sirikata::TimeProfiler::GroupMap [private]

typedef std::vector<Stage*> Sirikata::TimeProfiler::StageList [private]

Constructor & Destructor Documentation

Sirikata::TimeProfiler::TimeProfiler	(	const Context *	ctx,
		const String &	name
	)

Sirikata::TimeProfiler::~TimeProfiler ( )

References mFreeStages, and mGroups.

Member Function Documentation

TimeProfiler::Stage * Sirikata::TimeProfiler::addStage ( const String & name )

Add a stage for profiling, not categorized under any group.

Returns a Stage which can be used to update the statistics on each iteration. Note that the caller obtains ownership of the stage and is responsible for freeing it.

References mFreeStages, and Stage.

Referenced by Sirikata::CoordinateSegmentation::CoordinateSegmentation(), Sirikata::LoadMonitor::LoadMonitor(), Sirikata::LocationService::LocationService(), Sirikata::PollingService::PollingService(), Sirikata::Graphics::ResourceLoader::ResourceLoader(), Sirikata::ServerMessageQueue::ServerMessageQueue(), Sirikata::ServerMessageReceiver::ServerMessageReceiver(), Sirikata::SessionManager::SessionManager(), and Sirikata::TimeSteppedSimulation::TimeSteppedSimulation().

TimeProfiler::Stage * Sirikata::TimeProfiler::addStage	(	const String &	group_name,
		const String &	name
	)

Add a stage for profiling under the specified group.

Returns a Stage which can be used to update the statistics on each iteration. Note that the caller obtains ownership of the stage and is responsible for freeing it.

References mGroups, and Stage.

void Sirikata::TimeProfiler::remove ( Stage * stage ) [private]

References mFreeStages, and mGroups.

void Sirikata::TimeProfiler::report ( ) const

References Sirikata::Logging::info, mContext, mFreeStages, mGroups, mName, Sirikata::Time::null(), PROFILER_LOG, Sirikata::Context::recentSimTime(), and Sirikata::TimeProfiler::Stage::report().