GPT::IProfilerSvc Class Reference

Simple interface for the profiler service. More...

#include <IProfilerSvc.h>

Inheritance diagram for GPT::IProfilerSvc:

Collaboration diagram for GPT::IProfilerSvc:

Public Member Functions
	DeclareInterfaceID (IProfilerSvc, 0, 1)
	Interface ID definition. More...
virtual StatusCode	startCPUProfiling (const std::string &filename="gpt.profile")=0
	Start GPT profiling. More...
virtual StatusCode	stopCPUProfiling ()=0
	Stop the GPT profiling. More...
virtual bool	isCPUProfilingRunning () const =0
	Is the GPT profiling running at the moment? More...

Detailed Description

Simple interface for the profiler service.

   In order to allow clients to interact directly with the profiler
   service, this interface is used. But for basic profiling the
   users don't actually have to use it.

Author

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 27 of file IProfilerSvc.h.

Member Function Documentation

DeclareInterfaceID()

GPT::IProfilerSvc::DeclareInterfaceID	(	IProfilerSvc	,
		0	,
		1
	)

Interface ID definition.

isCPUProfilingRunning()

virtual bool GPT::IProfilerSvc::isCPUProfilingRunning ( ) const

pure virtual

Is the GPT profiling running at the moment?

This function can be used to ask the service whether CPU profiling is running at the moment.

Returns

true if the profiling is running at the moment, false otherwise

startCPUProfiling()

virtual StatusCode GPT::IProfilerSvc::startCPUProfiling ( const std::string &  filename = "gpt.profile" )

pure virtual

Start GPT profiling.

This function can be used to start the profiling, collecting the data into a file with the specified name.

Parameters

filename

Name of the GPT profile file

Returns

StatusCode::SUCCESS if the operation was successful, something else otherwise

stopCPUProfiling()

virtual StatusCode GPT::IProfilerSvc::stopCPUProfiling ( )

pure virtual

Stop the GPT profiling.

This function should be called to stop the CPU profiling.

Returns

StatusCode::SUCCESS if the operation was successful, something else otherwise

---

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

• IProfilerSvc.h